このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
Webhook After Recalling Official Account Messages/

Webhook After Recalling Official Account Messages

Feature Overview

The App backend can view the revocation of Official Account messages in real-time via this webhook.

Notes

To enable the webhook, you must configure the Webhook URL and toggle on the corresponding protocol. For more information on the configuration method, see Webhook Configuration document.
During this webhook, the IM backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For more security considerations, please refer to the Webhook Overview: Security Considerations document.

Webhook Triggering Scenarios

App users recall Official Account messages through the client.
An App administrator recalls an Official Account message via the REST API.

Webhook Triggering Timing

After the Official Account message has been successfully recalled.

API Calling Description

Sample request URL

In the subsequent example, the webhook URL configured within the app is https://www.example.com. Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request parameters

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
Webhook URL.
SdkAppid
SDKAppID assigned by the Chat console when an app is created.
CallbackCommand
Fixed to: OfficialAccount.CallbackAfterMsgWithDraw.
contenttype
Fixed value: JSON.
ClientIP
Client IP, such as: 127.0.0.1.
OptPlatform
Client Platform, for values please refer to Webhook Overview: Webhook Protocol for the meaning of the OptPlatform parameter.

Sample request

{
    "CallbackCommand":"OfficialAccount.CallbackAfterMsgWithDraw", // Webhook command
    "Official_Account":"#TOA#_123", // Official Account User ID
    "WithdrawMsgList":[ // List of MsgKey for message withdrawal           
        {
          "MsgKey":"71_1_1698741698"
        }
    ],
    "EventTime": 1670574414123// Event trigger timestamp in milliseconds		
}

Request fields

Object
Features
Feature
CallbackCommand
String
Webhook command.
Official_Account
String
Official Account User ID.
WithdrawMsgList
Array
List of MsgKey for message recall.
EventTime
Integer
Event trigger timestamp in milliseconds.

Sample response

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Ignore webhook result
}

Response fields

Field
Type
Attribute
Description
ActionStatus
String
Mandatory
Processed Request Result:
OK: Indicates successful processing
FAIL: Indicates failure
ErrorCode
Integer
Mandatory
Error Code, a 0 here means to ignore the response.
ErrorInfo
String
Mandatory
Error message.

References

Webhook Overview
RESTful API: Official account users send broadcast messages