- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Getting the List of Online Members in Community Group
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Getting the List of Online Members in Community Group
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
Feature Description
This API is used to remove one or multiple users from the blocklist.
API Invocation Description
Request URL example
https://xxxxxx/v4/sns/black_list_delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
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 |
https | The request protocol is HTTPS, and the request method is POST. |
xxxxxx | The country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/sns/black_list_delete | The Request API. |
sdkappid | The SDKAppID assigned by the IM console when an application is created. |
identifier | |
usersig | |
random | Enter a random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format. The value is always json. |
Maximum invocation frequency
The maximum invocation frequency is 200 times per second.
Request packet example
{"From_Account":"id","To_Account":["id1","id2","id3"]}
Request packet fields
Field | Type | Attribute | Description |
From_Account | String | Required | The identifier for which specific users are to be removed from their blocklist. |
To_Account | Array | Required | The list of identifiers to be removed from the blocklist. The number of To_Accounts in a single request cannot exceed 1,000. |
Response packet example
{"ResultItem":[{"To_Account":"id1","ResultCode":0,"ResultInfo":""},{"To_Account":"id2","ResultCode":0,"ResultInfo":""},{"To_Account":"id3","ResultCode":30006,"ResultInfo":"Err_SNS_BlackListCheck_Check_Reverse_BlackList_Fail"}],"Fail_Account":["id3"],"ActionStatus":"OK","ErrorCode":0,"ErrorInfo":"","ErrorDisplay":""}
Response packet fields
Field | Type | Description |
ResultItem | Array | The result object array for batch deletion from blocklist. |
To_Account | String | The identifier you request to be removed from the blocklist. |
ResultCode | Integer | The processing result of To_Account. 0: succeeded. Others: failed. |
ResultInfo | String | Error description for To_Account. If the processing is successful, the field is empty. |
Fail_Account | Array | The list of users that fails to be removed. This field is returned only when someone fails to be removed. |
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. |
Error Codes
Unless a network error (such as error 502) occurs, the HTTP return code for 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 admin permissions. |
30006 | An internal server error occurred. In this case, try again. |
30007 | The network connection timed out. In this case, try again later. |
30008 | A write conflict occurred due to concurrent writes. In this case, we recommend that you use the batch mode. |
예
아니오
문제 해결에 도움이 되었나요?