查询聊天室成员列表
查询指定聊天室的成员列表,最多返回 500 个成员,查询结果支持按加入时间正序或倒序排列。
请求方法
POST https://数据中心域名/chatroom/user/query.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
chatroomId | String | 是 | 要查询的聊天室 ID。 |
count | Int | 是 | 要获取的聊天室成员数,最多返回 500 个。 |
order | Int | 是 | 排序方式。1 为按加入时间正序,2 为按加入时间倒序。 |
请求示例
HTTP
POST /chatroom/user/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
chatroomId=10001&count=2&order=1
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Int | 返回码,200 表示成功。 |
total | Int | 当前聊天室中的用户总数。 |
users | String[] | 聊天室用户数组,最多为 500 个。 |
users[i].id | String | 成员的用户 ID。 |
users[i].time | String | 成员的加入时间,格式为 YYYY-MM-DD HH:MM:SS 。注意:time 的值与应用所属数据中心有关。如您的 App 业务使用国内数据中心,则 time 为北京时间;如使用海外数据中心,则为 UTC 时间。 |