https://xxxxxx/v4/sns/black_list_check?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com 首尔: adminapikr.im.qcloud.com 法兰克福: adminapiger.im.qcloud.com 硅谷: adminapiusa.im.qcloud.com 雅加达: adminapiidn.im.qcloud.com |
v4/sns/black_list_check | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
{"From_Account":"id","To_Account":["id1","id2","id3","id4","id5"],"CheckType":"BlackCheckResult_Type_Both"}
字段 | 类型 | 属性 | 说明 |
From_Account | String | 必填 | 需要校验该 UserID 的黑名单 |
To_Account | Array | 必填 | 待校验的黑名单的 UserID 列表,单次请求的 To_Account 数不得超过1000 |
CheckType | String | 必填 |
{"BlackListCheckItem": [{"To_Account": "id1","Relation": "BlackCheckResult_Type_BothWay","ResultCode": 0,"ResultInfo": ""},{"To_Account": "id2","Relation": "BlackCheckResult_Type_AWithB","ResultCode": 0,"ResultInfo": ""},{"To_Account": "id3","Relation": "BlackCheckResult_Type_BWithA","ResultCode": 0,"ResultInfo": ""},{"To_Account": "id4","Relation": "BlackCheckResult_Type_NO","ResultCode": 0,"ResultInfo": ""},{"To_Account": "id5","Relation": "BlackCheckResult_Type_NO","ResultCode": 30007,"ResultInfo": "Err_SNS_BlackListCheck_Check_Reverse_BlackList_Fail"}],"Fail_Account": ["id5"],"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","ErrorDisplay": ""}
字段 | 类型 | 说明 |
BlackListCheckItem | Array | 校验结果对象数组 |
To_Account | String | 请求校验的用户的 UserID |
Relation | String | |
ResultCode | Integer | To_Account 的处理结果,0表示成功,非0表示失败,非0取值的详细描述请参见 错误码说明 |
ResultInfo | String | To_Account 的错误描述信息,成功时该字段为空 |
Fail_Account | Array | 返回处理失败的用户列表,仅当存在失败用户时才返回该字段 |
ActionStatus | String | 请求包的处理结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败,非0取值的详细描述请参见 错误码说明 |
ErrorInfo | String | 详细错误信息 |
ErrorDisplay | String | 详细的客户端展示信息 |
错误码 | 描述 |
30001 | 请求参数错误,请根据错误描述检查请求参数 |
30003 | 请求的用户账号不存在 |
30004 | 请求需要 App 管理员权限 |
30006 | 服务器内部错误,请重试 |
30007 | 网络超时,请稍后重试 |
本页内容是否解决了您的问题?