Recall Message

Recalling a specific message essentially involves sending a recall command message. When the mobile client receives the recall command message, the original target message will be deleted, and a notification message with objectName as RC:RcNtf will be generated. The chat UI can display this based on RC:RcNtf.

The recall command message will also be stored in the message history. When the SDK retrieves the message history, it will fetch both the recall command message and the original message that was recalled. The mobile SDK has already implemented the deletion logic internally, so developers do not need to handle it additionally.

Service Activation

No service activation is required to use the Recall Message feature. Note: When recalling a message via the server, if the client of the recall operator is online, the client will synchronously execute the recall operation. If the operator's client remains offline for an extended period, the message recalled via the Server API might still be displayed on the sender's client upon their next login (the recipient is not affected). It is recommended to enable the Multi-Device Message Synchronization feature, which allows the SDK to automatically handle this when the sender's client logs in again. For activation details, refer to Message Management Service Configuration.

Request Method

POST: https://Data Center Domain/message/recall.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature validation. For details, refer to API Request Signature.

Parameter Description

Parameter	Type	Required	Description
fromUserId	String	Yes	The user ID of the message sender.
conversationType	Int	Yes	The conversation type. Supported conversation types include: 1 (one-to-one chat), 3 (group chat), 4 (chatroom), 6 (system conversation), 10 (ultra group).
targetId	String	Yes	The target ID, which can be a user ID, group ID, chatroom ID, ultra group ID, or system target ID, depending on the conversation type (ConversationType).
busChannel	String	No	The ultra group channel ID, applicable only for recalling ultra group messages. Usage requirements: If a channel ID was specified when sending the message, it must be specified when recalling; otherwise, the recall will fail. If no channel ID was specified when sending the message, it should not be specified when recalling; otherwise, the recall will fail. The field name for the channel ID when sending ultra group messages from the client is channelId.
messageUID	String	Yes	The unique identifier of the message. Can be obtained via the Post-messaging Callback service, where it is referred to as msgUID. For messages not supported by the Post-messaging Callback service, it can currently only be obtained from the Message History Log, where it is referred to as msgUID.
sentTime	Long	No	The sending time of the recalled message. Can be obtained via the Post-messaging Callback service, where it is referred to as msgTimestamp. For messages not supported by the Post-messaging Callback service, it can currently only be obtained from the Message History Log, where it is referred to as dateTime.
isAdmin	Int	No	Whether the user is an administrator. Default is 0. When set to 1, Global IM UIKit displays a gray bar notification as "Admin recalled a message."
isDelete	Int	No	Specifies whether the mobile client should delete the original message record locally and display the recall notification. Default is 0. When set to 0, the mobile client will only replace the original message content with a recall notification (gray bar) without deleting the original message record. When set to 1, the mobile client will delete the original message record and not display the recall notification (gray bar). Note: The IM server does not save the history of recalled ultra group messages. If isDelete is set to 0, the mobile client will retain the record (displayed as a recall notification), while the web client will not, which may lead to inconsistent user experiences.
disablePush	Boolean	No	Whether to perform a silent recall. Default is false. When set to true, offline users will not receive a recall notification. This field is not supported for chatroom and ultra group conversation types.
extra	String	No	Extended information that can contain any data. Not supported for ultra group conversations (conversationType is 10).
disableUpdateLastMsg	Boolean	No	Disables updating the last message in the conversation. When set to false, the sent message will appear in the conversation list; when set to true, it will not update the conversation list's message content. Note: This parameter only affects messages stored on the client.

Request Example

POST /message/recall.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

fromUserId=fDR2cVpxxR5zSMUNh3yAwh&targetId=MersNRhaKwJkRV9mJR5JXY&conversationType=1&messageUID=5FGT-7VA9-G4DD-4V5P&sentTime=1507778882124

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Type	Description
code	Number	The return code, 200 for success.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}