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 | Set to OfficialAccount.CallbackAfterSendMsg. |
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.CallbackAfterSendMsg", // Webhook command"Official_Account": "@TOA#_2J4SZEAEL", // Official account ID"MsgKey": "71_1_1698741698", // Unique identifier of the message, can be used to revoke Official Account messages through the REST API"MsgTime": 1490686222, // Time of the message"OnlineOnlyFlag": 1, // The value is `1` if it is an online message and `0` if it's not"MsgBody": [ // Message body, refer to TIMMessage object{"MsgType": "TIMTextElem", // Text"MsgContent": {"Text": "red packet"}}],"CloudCustomData": "your cloud custom data","EventTime": 1670574414123 // Millisecond level, event trigger timestamp}
Field | Type | Description |
CallbackCommand | String | Webhook command. |
Official_Account | String | Official Account User ID. |
MsgKey | String | |
MsgTime | Integer | Timestamp of the message, corresponding to the server time. |
OnlineOnlyFlag | Integer | Online message, `1` if true, otherwise `0`. |
MsgBody | Array | |
CloudCustomData | String | Custom message data (stored in the cloud, will be sent to the peer, and can be retrieved even after the app is uninstalled and reinstalled). |
EventTime | Integer | Event trigger timestamp in milliseconds. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // Ignore the 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?