跳到主要内容

查询聊天室属性(KV)

查询指定聊天室的自定义属性(KV)。

请求方法

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

频率限制: 每秒钟限 100 次

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

正文参数

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

参数类型必传说明
chatroomIdString聊天室 ID。
keysString批量获取指定聊天室中的 Key 值,最多上限为 100 个,不传时获取全部 key 值。

请求示例

POST /chatroom/entry/query.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&keys=Lnq9MJsPY&keys=Lnq88JsPY

返回结果

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

返回值返回类型说明
codeNumber返回码,200 为正常。
keysArray属性数组。
keys[i].keyString设置的属性名。
keys[i].valueString属性对应的内容。
keys[i].userIdString最后一次设置此 Key 的用户 ID。
keys[i].autoDeleteString用户退出聊天室后是否删除此 Key,0 为不删除、1为删除。
keys[i].lastSetTimeString最近一次设置 Key 的时间。

返回结果示例

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

{
"code":200,
"keys":
[{"key":"key1","value":"value1","userId":"2121","autoDelete":"0","lastSetTime":"2121"},
{"key":"key2","value":"value2","userId":"4343","autoDelete":"1","lastSetTime":"2121"}]
}