Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Message Related/
Withdraw Message/
Recalling Group Messages/

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)