设置聊天室属性(KV)
在指定聊天室中设置一个自定义属性 KV 对。您需要同时传入操作用户 ID,作为该 KV 对的所属用户。
聊天室销毁后,聊天室中的自定义属性同时销毁。
开通服务
使用聊天室属性(KV) 功能前,请确认已为当前 App Key 开通相关服务。详见聊天室属性概述。
如未开通服务,Server API 将返回 1009
错误。注意,在未开通服务时,如果连续请求导致 API 请求频率超过限制,Server API 会返回 HTTP 429 Too Many Requests 错误(错误码为 1008
)。
请求方法
POST: https://数据中心域名/chatroom/entry/set.json
频率限制: 每秒钟限操作 100 对 KV,与批量设置接口 /chatroom/entry/batch/set.json
共享限频配额。如果仅使用设置单个属性的 API,则一秒可调用 100 次。
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
chatroomId | String | 是 | 聊天室 ID。 |
userId | String | 是 | 操作用户 ID。通过 Server API 非聊天室中用户可以进行设置。 |
key | String | 是 | 聊天室属性名称,Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,大小写敏感。最大长度 128 字符。每个聊天室中,最多允许设置 100 个属性 Key-Value 对。 |
value | String |