查询单聊禁言用户列表
查询在单聊会话场景下被禁言的用户。
请求方法
POST: https://数据中心域名/user/chat/fb/querylist.json
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
频率限制: 每秒钟限 100 次
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
num | Int | 否 | 获取行数,默认为 100,最大支持 200 个。 |
offset | Int | 否 | 查询开始位置,默认为 0。 |
type | String | 是 | 会话类型,目前支持单聊会话 PERSON。 |
请求示例
POST /user/chat/fb/querylist.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
num=10&offset=0&type=PERSON
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
total | Int | 被禁言用户总数。 |
users | String[] | 被禁言用户数组。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"total": 3,
"users": [
"all_00001",
"all_00002",
"all_00003"
]
}