Skip to main content

Revoke Message

Brief Description

  • Simulate a user revoking a sent message.

Request Method

  • post

Request URL

  • {API_ADDRESS}/msg/revoke_msg
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"userID": "9906953281",
"conversationID": "si_2699373280_9906953281",
"seq": 2
}
Field NameOptionalTypeDescription
userIDRequiredstringRevoker's ID, message sender's ID or APP admin's ID; In group chat, it can also be the ID of a group member with a higher rank than yourself
conversationIDRequiredstringConversation ID
seqRequiredstringThe seq of this message

Success Return Example

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

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below
tokenstring
expireTimeSecondsstring

Failure Return Example

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

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message