Delete Message Extensions for One-to-One and Group Chats

Delete the extended information set for a sent one-to-one or group chat message based on the message ID.

When using the Server API to manipulate message extensions, the changes are not synchronized to the operator's client by default, which may lead to inconsistencies in the extension information. If needed, it is recommended to set the isSyncSender parameter to 1 and understand the usage details.

Request Method

POST: https://data center domain/message/expansion/delete.json

Rate Limit: 100 requests per second. Note, out of 100 requests, a maximum of 20 can be for deleting group chat message extensions. Also, see Known Issue 1.

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

Body Parameters

The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:

Parameter	Type	Required	Description
msgUID	String	Yes	The unique message ID, which can be obtained through the Post-messaging Callback feature. For details, refer to Post-messaging Callback.
userId	String	Yes	The operator's user ID, i.e., the user ID that needs to delete the extension information for the specified message (msgUID).
conversationType	String	Yes	The conversation type. Supported conversation types include: 1 (one-to-one chat) and 3 (group chat).
targetId	String	Yes	The target ID, which could be a user ID or group ID depending on the conversationType.
extraKey	String	Yes	The Key value of the extension information to be deleted. A maximum of 100 extension information items can be deleted at once.
isSyncSender	Int	No	The deletion operation generates an "extension operation message." This field specifies whether to synchronize this "extension operation message" to the sender's (the operator's) client. 1 means synchronization, and the default value is 0, meaning no synchronization. Note, setting this parameter alone does not ensure that the sender's client can always retrieve the sent message; you may need to enable other services. For details, refer to How to Synchronize Sent Messages to the Sender's Client.

Request Example

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

msgUID=BRGM-DEN2-01E4-BN66&userId=tjw3zbMrU&targetId=WNYZbMqpH&conversationType=1&extraKey=%5B%2211111%22%5D

Response

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

Return Value	Type	Description
code	Number	Return code, 200 indicates success.

Response Example

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

{"code":200}