删除聊天室属性(KV)
在指定聊天室中删除一个自定义属性 KV 对。该接口要求同时传入该 KV 对的所属用户 ID。
请求方法
POST: https://数据中心域名/chatroom/entry/remove.json
频率限制: 每秒钟限操作 100 对 KV,与批量删除接口 /chatroom/entry/batch/remove.json
共享限频配额。如果仅使用删除单个属性的 API,则一秒可调用 100 次。
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
chatroomId | String | 是 | 聊天室 ID。 |
userId | String | 是 | 操作用户 ID。通过 Server API 非聊天室中用户可以进行设置。 |
key | String | 是 | 聊天室属性名称,Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,大小写敏感。最大长度 128 字。 |
objectName | String | 否 | 通聊天室属性变化通知消息的消息类型,一般为内置消息类型 RC:chrmKVNotiMsg ,也可以是其他自定义消息类型。如果传入该字段,则在聊天室属性变化时发送一条消息。注意:从客户端 SDK 版本 4.0.2(Android / iOS) 与 3.0.6 (Web)开始,SDK 默认从服务端同步聊天室属性变化,不再依赖该通知消息。客户端可以设置聊天室属性变化监听器获取实时属性变化。 |
content | String | 否 | 聊天室属性变化通知消息的消息内容。JSON 结构,当 objectName 为 RC:chrmKVNotiMsg 时,content 必须包含 type、key、value 属性。RC:chrmKVNotiMsg 消息结构的详细说明请参见 聊天室属性通知消息。 |
请求示例
POST /chatroom/entry/remove.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
chatroomId=kvchatroom2&userId=jrT1igbKr
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}