批量设置聊天室属性(KV)
在指定聊天室中批量设置自定义属性 KV 对,单次最多 20 个 KV 对。如果属性已存在,该接口会强制覆盖原有 KV 对的所属用户 ID 和 Value。
聊天室销毁后,聊天室中的自定义属性同时销毁。
开通服务
使用聊天室属性(KV) 功能前,请确认已为当前 App Key 开通相关服务。详见聊天室属性概述。
如未开通服务,Server API 将返回 1009
错误。注意,在未开通服务时,如果连续请求导致 API 请求频率超过限制,Server API 会返回 HTTP 429 Too Many Requests 错误(错误码为 1008
)。
请求方法
POST: https://数据中心域名/chatroom/entry/batch/set.json
频率限制: 每秒钟限操作 100 对 KV,与 /chatroom/entry/set.json
共享限频配额。如:一次设置 1 个属性,一秒可调用 100 次。一次设置 20 个属性,一秒可调用 5 次。
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
请求参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
chatroomId | String | 是 | 聊天室 ID |
autoDelete | Int | 否 | 用户(entryOwnerId )退出聊天室后,是否删除此 Key 值。为 1 时删除此 Key 值和对应的 Value,为 0 时用户退出后不删除,默认为 0。 |
entryOwnerId | String | 是 | 聊天室自定义属性的所属用户 ID |
entryInfo | String | 是 | 聊天室自定义属性 KV 对,JSON 结构,一次最多 20 个 KV。Key 为属性名,支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,大小写敏感。最大长度 128 字符。Value 为属性值,最大长度 4096 个字符。 |
请求示例
POST /chatroom/entry/batch/set.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX(最大长度36)
chatroomId=gid1&autoDelete=true&entryOwnerId=test&entryInfo={"key1":"value1","key2":"value2"}
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Int | 返回码。200 表示处理成功 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"code":200}