跳到主要内容

查询白名单服务状态

查询指定用户是否开启白名单过滤功能。

请求方法

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

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

频率限制: 每秒钟限 100 次

正文参数

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

参数类型必传说明
userIdString用户 ID,最多查询 20 个。

请求示例

POST /user/whitesetting/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=98&userId=99

返回结果

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

返回值返回类型说明
codeNumber返回码,200 为正常。
usersString[]用户状态列表。
userIdString用户 ID。
whiteSettingString状态,1 为开启白名单、0 为开启黑名单,默认为黑名单。

返回结果示例

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

{
"code":200,
"users": [
{
"whiteSetting": "0",
"userId": "00"
}
]}