跳到主要内容

批量移除聊天室属性(KV)

在指定聊天室中批量删除自定义属性 KV 对,单次最多 20 个 KV 对。该接口会强制删除 KV 对,不要求传入待删除 KV 对的所属用户 ID。应用中管理员角色用户可使用该接口清除指定聊天室内的业务数据。

请求方法

POST: https://数据中心域名/chatroom/entry/batch/remove.json

频率限制: 每秒钟限 100 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

请求参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
chatroomIdString聊天室 ID
entryOwnerIdString自定义属性的所属用户 ID。
entryKeysArray需要删除的 key 的集合。

请求示例

POST /chatroom/entry/batch/remove.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=gid1entryOwnerId=test&entryKeys=["key1","key2"]

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeInt返回码。200 表示处理成功

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX

{"code":200}