please select
  • UIKit
  • SDK
  • Server APIs
Chat/
Server APIs/
RESTful APIs/
User Management/
Blocklist/
Server APIs
  • Generating UserSig
  • RESTful APIs
    • RESTful API Overview
    • RESTful API List
    • Message Related
      • Send Message
        • Sending One-to-One Messages to One User
        • Sending One-to-One Messages to Multiple Users
        • Sending Ordinary Messages in a Group
        • Sending System Messages in a Group
        • Broadcast Message of Audio-Video Group
        • Importing One-to-One Messages
        • Importing Group Messages
      • Historical Message
        • Modifying Historical One-to-one Messages
        • Modifying Historical Group Messages
        • Pulling Historical One-to-one Messages
        • Pulling Historical Group Messages
      • Delete Message
        • Deleting Messages Sent by a Specified User
      • Withdraw Message
        • Recalling One-to-One Messages
        • Recalling Group Messages
      • Read Receipt
        • Marking One-to-One Messages as Read
        • Pulling Group Message Read Receipt Details
        • Pulling Read Receipts for Group Messages
      • Message Extension
        • Pulling the Message Extension of a One-to-One Message
        • Configuring Message Extension for a One-to-One Message
        • Pulling Message Extension of a Group Message
        • Configuring Message Extension for a Group Message
      • Pushing to All Users
        • API for Pushing to All Users
        • Pushing to All Users
        • Setting Application Attribute Names
        • Getting Application Attribute Names
        • Getting User Attributes
        • Setting User Attributes
        • Deleting User Attributes
        • Getting User Tags
        • Adding User Tags
        • Deleting User Tags
        • Deleting All Tags of a User
    • Session Related
      • Conversation List
        • Pulling a conversation list
      • Session Unread Count
        • Setting the Unread Message Count of a Member
        • Querying Unread One-to-One Message Count
      • Delete Session
        • Deleting a conversation
      • Session Grouping Tag
        • Creating Conversation Group Data
        • Updating Conversation Group Data
        • Deleting Conversation Group Data
        • Creating or Updating Conversation Mark Data
        • Searching for Conversation Group Marks
        • Pulling Conversation Group Mark Data
    • Group Related
      • Group Management
        • Getting All Groups in an App
        • Creating a Group
        • Disbanding a Group
        • Getting the Groups a User Has Joined
      • Group Information
        • Getting Group Profiles
        • Modifying the Profile of a Group
        • Importing a Group Profile
      • Group Member Management
        • Adding Group Members
        • Deleting Group Members
        • Banning Group Members
        • Unbanning Group Members
        • Bulk Muting and Unmuting
        • Getting the List of Muted Group Members
        • Changing Group Owner
        • Querying the Roles of Users in a Group
        • Importing Group Members
      • Group Member Information
        • Getting Group Member Profiles
        • Modifying the Profile of a Group Member
      • Group Custom Attributes
        • Getting Group Custom Attributes
        • Modifying Group Custom Attributes
        • Clearing Group Custom Attributes
        • Resetting Group Custom Attributes
        • Deleting Group Custom Attributes
      • Live Group Management
        • 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
      • Group Counter
        • Getting Group Counters
        • Updating Group Counters
        • Deleting Group Counters
    • User Management
      • Account Management
        • Importing a Single Account
        • Importing Multiple Accounts
        • Deleting Accounts
        • Querying Accounts
      • User Information
        • Setting Profiles
        • Pulling Profiles
      • User Status
        • Invalidating Account Login States
        • Querying Account Online Status
      • Friend Management
        • Adding Friends
        • Importing Friends
        • Updating Friends
        • Deleting Friends
        • Deleting All Friends
        • Verifying Friends
        • Pulling Friends
        • Pulling Specified Friends
      • Friend Lists
        • Adding Lists
        • Deleting Lists
        • Pulling Lists
      • Blocklist
        • Blocklisting Users
        • Unblocklisting Users
        • Pulling a Blacklist
        • Verifying Users on a Blocklist
    • Global Mute Management
      • Setting Global Mute
      • Querying Global Mute
    • Operations Management
      • Pulling Operations Data
      • Downloading Recent Messages
      • Getting Server IP Addresses
    • Chatbots
      • Pulling Chatbot Accounts
      • Creating Chatbot Accounts
      • Deleting Chatbot Accounts
  • Webhooks
    • Webhook Overview
    • Webhook Command List
    • Operations Management Callbacks
      • API Overclocking Alarm Callbacks
    • Online Status Webhooks
      • Status Change Webhooks
    • Relationship Chain Webhooks
      • After a Profile Is Updated
      • Before a Friend Is Added
      • Before a Friend Request Is Responded
      • After a Friend Is Added
      • After a Friend Is Deleted
      • After a User Is Added to Blocklist
      • After a User Is Removed from Blocklist
    • One-to-One Message Webhooks
      • Before a One-to-One Message Is Sent
      • After a One-to-One Message Is Sent
      • After a One-to-One message Is Marked as Read
      • After A One-to-One Message Is Recalled
    • Group Webhooks
      • Before a Group Is Created
      • 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
      • Before Group Message Is Sent
      • After a Group Message Is Sent
      • After a Group Is Full
      • After a Group Is Disbanded
      • After Group Profile Is Modified
      • Callback After Recalling Group Messages
      • Webhook for Online and Offline Status of Audio-Video Group Members
      • Webhook for Exceptions When Group Messages Are Sent
      • Before a Topic Is Created
      • After a Topic Is Created
      • After a Topic Is Deleted
      • Topic Profile Change Webhook
      • Callback After Group Member Profile Changed
      • Callback After Group Attribute Changed
      • Callback After Read Receipt
      • Callback After the Group Owner Changed
    • Webhook Mutual Authentication Configuration Guide
      • Apache Mutual Authentication Configuration
      • Nginx Mutual Authentication Configuration
    • Chatbot webhooks
      • Chatbot Passthrough Message Callback
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
User Management/
Blocklist/
Blocklisting Users/

Blocklisting Users

API Description

This API is used to add one or multiple people to your blocklist.
Note
If users A and B are friends, either one adding the other to the blocklist removes them from each other’s friend list. If user A blocks user B, or vice versa, then neither of them can send a friend request to the other person.
If user B is on user A’s blocklist and user A is also on user B’s blocklist, then user A and B cannot start a conversation with each other. -> If user B is on user A’s blocklist, but user A is not on user B’s blocklist, then user A can message user B but not the other way around.

API Call Description

Sample request URL

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

Request parameters

The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see the 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.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/sns/black_list_add
Request API
sdkappid
The SDKAppID assigned by the IM console when the application is created.
identifier
The administrator account of the app. For more information, refer to App Administrator.
usersig
The signature generated in the app administrator account. For details on how to generate the signature, refer to Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format. The value is always json.

Maximum call frequency

200 calls per second

Sample request

{
    "From_Account":"id",
    "To_Account":["id1","id2","id3"]
}

Request fields

Field
Type
Required
Description
From_Account
String
Yes
The UserID that initiates the blocklist request.
To_Account
Array
Yes
A list of UserIDs to be added to the blocklist. This array should not contain more than 1000 UserIDs.

Sample response

{
    "ResultItem":
    [
        {
            "To_Account":"id1",
            "ResultCode":0,
            "ResultInfo":""
        },
        {
            "To_Account":"id2",
            "ResultCode":30001,
            "ResultInfo":"Err_SNS_BlackListAdd_Already_Exist"
        },
        {
            "To_Account":"id3",
            "ResultCode":30002,
            "ResultInfo":"Err_SNS_BlackListAdd_SdkAppId_Illegal"
        }
    ],
    "Fail_Account":["id2","id3"],
    "ActionStatus":"OK",
    "ErrorCode":0,
    "ErrorInfo":"",
    "ErrorDisplay":""
}

Response fields

Field
Type
Description
ResultItem
Array
The result of batch blocking, which is an array of UserIDs and corresponding results.
To_Account
String
The UserID that you requested to add to blocklist.
ResultCode
Integer
The result. 0 means success and other values mean failure. For details on non-zero results, see Error Codes.
ResultInfo
String
Error description. This field is empty when the request succeeds.
Fail_Account
Array
A list of users that failed to be added to the blocklist. This field is only returned when at least one user fails.
ActionStatus
String
The result of the request. OK means the request is successfully handled. FAIL means the request failed.
ErrorCode
Integer
Error code. 0 means success and other values mean failure. For details on non-zero results, see Error Codes.
ErrorInfo
String
Detailed error information.
ErrorDisplay
String
Detailed information displayed on the client.

Error Codes

Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response fields such as ResultCode, ResultInfo, ErrorCode, and ErrorInfo. For public error codes (60000 to 79999), see Error Codes. The list below contains only error codes specific to this API:
Error Code
Description
30001
Wrong request parameter. Check your request according to the error description.
30002
The SDKAppID does not match.
30003
The requested user account does not exist.
30004
The request requires app administrator permissions.
30006
Internal server error. Please try again.
30007
Request timed out. Please try again later.
30008
A write conflict has occurred due to concurrent write operations. We recommend that you use batch processing.
30013
The maximum number of blocked users has been reached.

API Debugging Tool

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

See Also

Deleting a user from the blocklist
Querying a blocklist
Verifying a blocklist

Possible Callback