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

Deleting Accounts

Feature Description
The IM trial edition and IM developer edition applications support account deletion by default. For other types of applications (such as: TRTC, whiteboard, professional edition, ultimate edition), it needs to be enabled in the console.
Note:
For specific package types, you can enter the application page in the Console, and click Application > Application Details > Plan to view.
Note:
After deleting an account, the user's data will be irrecoverable, please use this interface with caution.
When deleting an account, that user's relationship chain, profile, groups, sessions, and other data will also be deleted.
The IM trial edition and IM developer edition support importing deleted UserIDs. For other types of applications (such as: TRTC, whiteboard, professional edition, ultimate edition), deleted UserIDs are not allowed to be re-imported within 3 months.
API Calling Description
Sample request URL
https://xxxxxx/v4/im_open_login_svc/account_delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
 The following table only describes the modified parameters when this API is called. For more information on other parameters, please 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.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/im_open_login_svc/account_delete
Request API
sdkappid
SDKAppID assigned by the console when the app is created
identifier
App admin account. For more information, please see the App Admin section in Login Authentication.
usersig
Signature generated in the app admin account. For details on how to generate the signature, please see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
Request format. The value is always json.
Maximum calling frequency
100 calls per second
Sample request packet
{
  "DeleteItem":
  [
      {
          "UserID":"UserID_1"
      },
      {
          "UserID":"UserID_2"
      }
  ]
}
Request packet fields
Field
Type
Required
Description
DeleteItem
Array
Yes
Account array to delete. A single request can contain up to 100 accounts.
UserID
String
Yes
UserID of the account to delete
Sample response packet
{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ResultItem": [
        {
            "ResultCode": 0,
            "ResultInfo": "",
            "UserID": "UserID_1"
        },
        {
            "ResultCode": 70107,
            "ResultInfo": "Err_TLS_PT_Open_Login_Account_Not_Exist",
            "UserID": "UserID_2"
        }
    ]
}
Response packet fields
Field
Type
Description
ActionStatus
String
Request result. OK: successful; FAIL: failed
ErrorCode
Integer
Error code. 0: successful; other values: failed
ErrorInfo
String
Error information about the request failure
ResultItem
Array
Array of results for different accounts
ResultCode
Integer
Error code for the account. 0: successful; other values: failed
ResultInfo
String
Error information about the failure to delete the account
UserID
String
UserID of the account to delete
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 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
30006
An internal server error occurred while clearing relationship chain data. Try again later.
30007
Internal server timeout occurred while clearing relationship chain data. Try again later.
30008
A write conflict occurred while writing relationship chain data. You are advised to use the batch mode.
40006
An internal server error occurred while clearing profiles. Try again later.
70107
The UserID to delete does not exist. Make sure that the UserID is valid.
70169
Server timeout. Try again later.
70202
Server timeout. Try again later.
70402
Invalid parameters. Make sure that the required fields are all entered and the parameter settings meet the protocol requirements.
70403
Request failed. App admin permissions are required to perform this operation.
70500
Internal server error. Try again later.
71000
Failed to delete accounts. Only accounts of apps using the IM Trial plan can be deleted. Your current app is using the Pro plan and therefore does not support deleting accounts.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
References
Importing a Single Account (v4/im_open_login_svc/account_import)
Importing Multiple Accounts (v4/im_open_login_svc/multiaccount_import)
Querying Accounts (v4/im_open_login_svc/account_check)
Invalidating Account Login States (v4/im_open_login_svc/kick)
Querying Account Online Status (v4/openim/query_online_status)

Feature Description
API Calling Description
Error Codes
API Debugging Tool
References

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/im_open_login_svc/account_delete	Request API
sdkappid	`SDKAppID` assigned by the console when the app is created
identifier	App admin account. For more information, please see the App Admin section in Login Authentication.
usersig	Signature generated in the app admin account. For details on how to generate the signature, please see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype	Request format. The value is always `json`.

Field	Type	Required	Description
DeleteItem	Array	Yes	Account array to delete. A single request can contain up to 100 accounts.
UserID	String	Yes	`UserID` of the account to delete

Error Code	Description
30006	An internal server error occurred while clearing relationship chain data. Try again later.
30007	Internal server timeout occurred while clearing relationship chain data. Try again later.
30008	A write conflict occurred while writing relationship chain data. You are advised to use the batch mode.
40006	An internal server error occurred while clearing profiles. Try again later.
70107	The `UserID` to delete does not exist. Make sure that the `UserID` is valid.
70169	Server timeout. Try again later.
70202	Server timeout. Try again later.
70402	Invalid parameters. Make sure that the required fields are all entered and the parameter settings meet the protocol requirements.
70403	Request failed. App admin permissions are required to perform this operation.
70500	Internal server error. Try again later.
71000	Failed to delete accounts. Only accounts of apps using the IM Trial plan can be deleted. Your current app is using the Pro plan and therefore does not support deleting accounts.