Docs Overview/
Chat/
Server APIs/
RESTful APIs/
User Management/
Blocklist/
Verifying Users on a Blocklist/

Verifying Users on a Blocklist

Feature Overview

Batch verifies users in the blocklist

API Calling Description

Sample request URL

https://xxxxxx/v4/sns/black_list_check?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/sns/black_list_check
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format, which should always be json.

Maximum call frequency

200 calls per second

Sample request

{
    "From_Account":"id",
    "To_Account":["id1","id2","id3","id4","id5"],
    "CheckType":"BlackCheckResult_Type_Both"
}

Request fields

Field
Type
Required
Description
From_Account
String
Yes
UserID that requests blocklist verification
To_Account
Array
Yes
List of UserIDs for blocklist verification. This field supports up to 1,000 UserIDs per request.
CheckType
String
Yes
Verification mode. For more information, see Verifying a blocklist.

Sample response

{
    "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": ""
}

Response fields

Field
Type
Description
BlackListCheckItem
Array
Verification result object array
To_Account
String
UserID of the account that requests blocklist verification
Relation
String
The blocklist relationship between To_Account and From_Account upon successful verification. For details, see Verifying a blocklist.
ResultCode
Integer
Result of To_Account. 0: Successful. Other values: Failed. For details on non-zero results, see Error Codes.
ResultInfo
String
The error description of To_Account. This field is empty if the request succeeds.
Fail_Account
Array
The users that failed to be verified. This field is only returned when at least one user fails.
ActionStatus
String
The request result. OK: successful. FAIL: failed.
ErrorCode
Integer
Error code. 0: successful. Other values: failed. For details on non-zero results, see Error Codes.
ErrorInfo
String
Detailed error information
ErrorDisplay
String
Detailed information displayed on the client


Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ResultCode, ResultInfo, ErrorCode, and ErrorInfo. For public error codes (60000 to 79999), please see Error Codes. The following table describes the error codes specific to this API:
Error Code
Description
30001
Incorrect request parameter. Check your request according to the error description.
30003
The requested account does not exist.
30004
The request requires app admin permissions.
30006
Internal server error. Try again.
30007
Network timeout. Try again later.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

References

Unblocklisting users
Pulling a blocklist
Verifying users on a blocklist