查询单聊用户白名单中的用户列表

查询指定用户的单聊用户白名单的用户列表。仅单聊用户白名单中的用户可向当前用户发送消息。

使用该接口前请确认已开启单聊用户白名单服务。详见白名单服务概述。

请求方法

POST： https://数据中心域名/user/whitelist/query.json

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

频率限制： 每秒钟限 100 次

正文参数

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

参数	类型	必传	说明
userId	String	是	用户 ID。
pageToken	String	否	分页信息，取自上一次请求返回 next 参数，不传时不做分页处理，默认获取前 1000 个用户列表，按加入白名单时间倒序排序。
size	Int	否	分页获取单聊用户白名单用户时每页行数，不传时默认为 1000 条，最大不超过 1000 条

请求示例

HTTP

POST /user/whitelist/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

userId=jlk456j5&pageToken=COIB&size=10

返回结果

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

返回值	返回类型	说明
code	Int	返回码，200 为正常。
users	String[]	白名单用户数组。
next	String	分页标识符，存在下一页时返回，下次请求时传入。

返回结果示例

HTTP

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

{
    "code": 200,
    "next": "CNgB",
    "users": [
        "uid20",
        "uid19",
        "uid18",
        "uid17",
        "uid16",
        "uid15",
        "uid14",
        "uid13",
        "uid12",
        "uid11"
    ]
}