This API is used to verify blocklist.
https://console.tim.qq.com/v4/sns/black_list_check?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
The following table lists and describes only the parameters to be modified when this API is invoked. For details on other parameters, see RESTful API Overview.
Parameter | Description |
---|---|
v4/sns/black_list_check | The request API. |
sdkappid | The SDKAppID assigned by the IM console when an application is created. |
identifier | This must be the app admin account. For details, see App Admins. |
usersig | The signature generated by the app admin account. For details, see Generating UserSig. |
random | Enter a random 32-bit unsigned integer ranging from 0 to 4294967295. |
The maximum invocation frequency is 200 times per second.
{
"From_Account":"id",
"To_Account":["id1","id2","id3","id4","id5"],
"CheckType":"BlackCheckResult_Type_Both"
}
Field | Type | Attribute | Description |
---|---|---|---|
From_Account | String | Required | The identifier whose blocklist needs to be verified. |
To_Account | Array | Required | The list of blocked identifiers to be verified. Up to 1,000 To_Account entries are supported in a single request. |
CheckType | String | Required | The verification mode. For details, see Verifying Blocklists. |
{
"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": ""
}
Field | Type | Description |
---|---|---|
BlackListCheckItem | Array | The array of verification result objects. |
To_Account | String | The identifier of the account to be verified. |
Relation | String | Blocklist relationship between To_Account and From_Account upon successful verification. For details, see Verifying Blocklists. |
ResultCode | Integer | The processing result of To_Account. 0: succeeded. Others: failed. |
ResultInfo | String | Error description for To_Account. If the processing was successful, the field is empty. |
Fail_Account | Array | The list of users that fails to be verified. This field is returned only when someone fails to be verified. |
ActionStatus | String | The request packet processing result. OK: succeeded. FAIL: failed. |
ErrorCode | Integer | The error code. 0: succeeded. Others: failed. |
ErrorInfo | String | Detailed error information. |
ErrorDisplay | String | Detailed error information to be displayed on the client. |
Unless a network error (such as error 502) occurs, the HTTP return code of this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.
Error Code | Description |
---|---|
30001 | A request parameter is incorrect. In this case, check request parameters based on the error description. |
30003 | The requested user account does not exist. |
30004 | The request requires app administrator permissions. |
30006 | An internal server error occurred. In this case, try again. |
30007 | The network connection timed out. In this case, try again later. |
Use the RESTful online commissioning tool for APIs to commission this API.
Was this page helpful?