製品の概要
Basic Concepts
ユースケース
機能概要
アカウントシステム
ユーザープロフィールとリレーションシップチェーン
メッセージ管理
グループシステム
Official Account
Audio/Video Call
使用制限
https://xxxxxx/v4/sns/black_list_get?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comTokyo： adminapijpn.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/sns/black_list_get | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json. |
{"From_Account": "id","StartIndex": 0,"MaxLimited": 30,"LastSequence": 12}
Field | Type | Required | Description |
From_Account | String | Yes | UserID whose blocklist is to be pulled |
StartIndex | Integer | Yes | Starting point for the blocklist pull |
MaxLimited | Integer | Yes | Maximum number of blocklisted users that can be pulled per page Note： Since the total number of blocklists is up to 1000, the number of blocklists per request must not exceed 1000. |
LastSequence | Integer | Yes | Seq that the backend returns to the client in the last blocklist pull. The value is 0 for the first pull. (For a RESTful API, enter 0.) |
{"BlackListItem": [{"To_Account": "id1","AddBlackTimeStamp": 1430000001},{"To_Account": "id2","AddBlackTimeStamp": 1430000002}],"StartIndex": 0,"CurruentSequence": 13,"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","ErrorDisplay": ""}
Field | Type | Description |
BlackListItem | Array | Blocklist object array. Each blocklist object contains a To_Account and an AddBlackTimeStamp. |
To_Account | String | UserID in the blocklist |
AddBlackTimeStamp | Integer | Blocklisted time |
StartIndex | Integer | Starting position for the next page pull. 0 indicates that the entire blocklist has been pulled. |
CurrentSequence | Integer | Latest Seq of the blocklist |
ActionStatus | String | Request result. OK: successful; FAIL: failed |
ErrorCode | Integer | Error code. 0: successful. Other values: failed. For details on non-zero results, please see Error Codes. |
ErrorInfo | String | Detailed information about the error. |
ErrorDisplay | String | Detailed information displayed on the client |
ErrorCode and ErrorInfo respectively.
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. |
フィードバック