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

Recalling Group Messages

Feature Overview
This API enables admins to recall group messages.
This API enables the recall of all group messages valid for roaming, including group messages sent from a client and those sent with a RESTful API.
To recall group messages sent from a client, enable After a Group Message Is Sent first, which records the GroupId and MsgSeq of each group message, and then enter the GroupId and MsgSeqList obtained from the webhook in this API to recall the message. Alternatively, get information of group messages to be recalled with Pulling Historical Messages, and then recall the message with this API.
To recall group messages sent with the RESTful API Sending Ordinary Messages in a Group, get MsgSeq contained in the response packets of these APIs and then recall the messages.
Once a message is recalled by this API, it is recalled from the local caches of the sender’s and recipients’ clients.
This API can recall group messages sent for any period of time, but the group messages must be valid for roaming.
API Calling Description
Applicable group types
Group type ID
Group Message Recall
Private
Yes. Same as work groups (Work) in the new version.
Public
Yes
ChatRoom
Yes. Same as the meeting group (Meeting) in the new version.
AVChatRoom
Yes. Supported from Native SDK 7.4.4634 and Web SDK 3.1.2.
Community
Yes
These are the preset group types in Chat. For more information, see Group System.
Sample request URL
https://xxxxxx/v4/group_open_http_svc/group_msg_recall?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to 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/group_open_http_svc/group_msg_recall
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format, which should always be json.
Maximum call frequency
200 calls per second
Sample request
The message recall operation is irrevocable. Please call this API with caution.
{
    "GroupId": "@TGS#2J4SZEAEL",
    "MsgSeqList":[
        {
            "MsgSeq":100
        },
        {
            "MsgSeq":101
        }
    ]
}
Request fields
Field
Type
Required
Description
GroupId
String
Yes
The ID of the Group whose historical messages will be modified
MsgSeqList
Array
Yes
The sequence list of messages to be recalled. Up to 10 message sequences can be contained in a request.
MsgSeq
Integer
Yes
The sequence of the message to be recalled.
TopicId
String
No
Topic ID, which indicates message recall in the corresponding topic and applies only to topic-enabled communities.
Sample response
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RecallRetList":[
        {
            "MsgSeq":100,
            "RetCode":10030
        },
        {
            "MsgSeq":101,
            "RetCode":0
        }
    ]
}
Response 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
RecallRetList
Array
Result details of the message recall request.
MsgSeq
Integer
The sequence of an individual recalled message.
RetCode
Integer
The recall result of an individual message. 0 for success and others for failures. See the error codes below for more details.
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), see Error Codes.
The following table describes the error codes specific to this API:
Error Code
Description
10002
Internal server error. Try again.
10003
Invalid command word.
10004
Invalid parameter. Check the error description and troubleshoot the issue.
10007
No operation permissions. The operator must have permissions to perform corresponding operations.
10010
The group does not exist or has been deleted.
10015
Invalid group ID. Use the correct group ID.
10030
The message requested does not exist.
10031
The message requested is beyond the allowed time range.
10032
The message requested cannot be recalled.
10033
This type of group does not support message recalls.
10041
The app (SDKAppID) is configured not to support group message recalls.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
References
Sending System Messages in a Group (v4/group_open_http_svc/send_group_system_notification)

Feature Overview
API Calling Description
Error Codes
API Debugging Tool
References

Group type ID	Group Message Recall
Private	Yes. Same as work groups (Work) in the new version.
Public	Yes
ChatRoom	Yes. Same as the meeting group (Meeting) in the new version.
AVChatRoom	Yes. Supported from Native SDK 7.4.4634 and Web SDK 3.1.2.
Community	Yes

Parameter	Description
xxxxxx	Domain name corresponding to 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/group_open_http_svc/group_msg_recall	Request API
sdkappid	SDKAppID assigned by the Chat console when an app is created
identifier	App admin account. For more information, see the App Admin section in Login Authentication.
usersig	Signature generated by the app admin account. For details, see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype	Request format, which should always be `json`.

Field	Type	Required	Description
GroupId	String	Yes	The ID of the Group whose historical messages will be modified
MsgSeqList	Array	Yes	The sequence list of messages to be recalled. Up to 10 message sequences can be contained in a request.
MsgSeq	Integer	Yes	The sequence of the message to be recalled.
TopicId	String	No	Topic ID, which indicates message recall in the corresponding topic and applies only to topic-enabled communities.

Error Code	Description
10002	Internal server error. Try again.
10003	Invalid command word.
10004	Invalid parameter. Check the error description and troubleshoot the issue.
10007	No operation permissions. The operator must have permissions to perform corresponding operations.
10010	The group does not exist or has been deleted.
10015	Invalid group ID. Use the correct group ID.
10030	The message requested does not exist.
10031	The message requested is beyond the allowed time range.
10032	The message requested cannot be recalled.
10033	This type of group does not support message recalls.
10041	The app (SDKAppID) is configured not to support group message recalls.