Revoke Message

Brief Description

• Simulate a user revoking a previously sent message.

Request Method

• post

Request URL

• {API_ADDRESS}/msg/revoke_msg

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	Used for global trace tracking, suggested to use a unique timestamp per request
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Parameters Example

{
  "userID": "9906953281",
  "conversationID": "si_2699373280_9906953281",
  "seq": 2
}

Field Name	Optional	Type	Description
userID	Required	string	ID of the user revoking the message; can be the message sender’s ID or app admin ID. In group chats, it can also be a user with a higher role.
conversationID	Required	string	Conversation ID where the message was sent.
seq	Required	string	Sequence number of the message to revoke.

Success Response Example

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

Success Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code; 0 indicates success.
errMsg	string	Brief error message, empty if none.
errDlt	errDlt	Detailed error information, empty if none.
data	object	General data object, structure detailed below.
token	string	Returned token, if applicable.
expireTimeSeconds	string	Token expiration time in seconds, if applicable.

Failure Response Example

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Failure Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code, refer to global error code documentation
errMsg	string	Brief error message
errDlt	errDlt	Detailed error information