SDKAppID
of the app.https://www.example.com
.
Example:https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
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. |
{"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}
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. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // Ignore webhook result}
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. |
Was this page helpful?