Recall a group message

Overview

You can call this operation to recall a group message sent within two minutes. To recall an earlier message, contact ZEGOCLOUD technical support. You can recall a message sent within 24 hours at maximum.

After a message is recalled, recipients receive the notification in the following ZIM SDK callbacks.

Request method and endpoint

• Request method: POST
• Request URL: https://zim-api.zego.im/?Action=RevokeGroupMessage
• Protocol: HTTPS
• QPS limit: 20 calls per second

Request parameters

The following table describes only the operation-specific request parameters and some common request parameters. For the complete list of common request parameters, see the Common request parameters section of the Accessing Server APIs topic.

Sample request

• Request URL:

  https://zim-api.zego.im/?Action=RevokeGroupMessage
  &<Common request parameters>

  https://zim-api.zego.im/?Action=RevokeGroupMessage
  &<Common request parameters>

• Request body:

    {
        "FromUserId": "u1",
        "GroupId": "group1",
        "MsgSeq": 10,
        "Payload": "payload",
        "OfflinePush" :{
            "Enable":1,
            "Title":"title",
            "Content":"content",
            "Payload":"payload"
        }
    }

    {
        "FromUserId": "u1",
        "GroupId": "group1",
        "MsgSeq": 10,
        "Payload": "payload",
        "OfflinePush" :{
            "Enable":1,
            "Title":"title",
            "Content":"content",
            "Payload":"payload"
        }
    }

Response parameters

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

Return codes

The following table describes only the return codes related to the business logic of the operation. For the complete list of return codes, see Return codes.