跳到主要内容

查询聊天室属性（KV）

本文档指导您如何查询指定聊天室的自定义属性（Key-Value 键值对）。

请求方法​

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

频率限制： 每秒钟限 100 次

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

正文参数​

请求正文采用 application/x-www-form-urlencoded 格式，支持以下参数：

参数类型必传说明
chatroomIdString是目标聊天室的 ID
keysString否指定要查询的属性键名，可重复传递多个同名参数（最多 100 个），不传则返回该聊天室所有属性

请求示例​

HTTP
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

返回结果​

响应为 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
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"
        }
    ]
}