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 | The SDKAppID assigned by the Chat console when an app is created. |
CallbackCommand | Fixed as OfficialAccount.CallbackBeforeSendMsg. |
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.CallbackBeforeSendMsg", // Webhook command"Official_Account": "@TOA#_2J4SZEAEL", // Official Account User ID"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 // Event trigger timestamp in milliseconds}
Field | Type | Description |
CallbackCommand | String | Webhook command. |
Official_Account | String | Official Account User ID. |
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 // 0 means allowed to speak}
10016
is returned to the requester.{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 1 // 1 means speaking is not allowed}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 2 // 2 means Silent Discard}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0, // Must be 0, only then can the modified message be properly dispatched"MsgBody": [ // Message after App changes; if absent, the user's sent message is the default{"MsgType": "TIMTextElem", // Text"MsgContent": {"Text": "red packet"}},{"MsgType": "TIMCustomElem", // Custom message"MsgContent": {"Desc": "CustomElement.MemberLevel", // Description"Data": "LV1" // Data}}],"CloudCustomData": "your cloud custom data"}
Field | Type | Attribute | Description |
ActionStatus | String | Mandatory | Processed Request Result: OK Signifies Successful Handling FAILURE signifies unsuccessful execution |
ErrorCode | Integer | Mandatory | Error Identifier: 0: Allow Speaking 1: Refuse to Speak 2: Silent discard If the service wishes to reject a speech while conveying the error code ErrorCode and ErrorInfo to the client, please set the ErrorCode within the range [120001, 130000]. |
ErrorInfo | String | Mandatory | Error message. |
MsgBody | Array | Optional | After modifications by the app, the modified message body will be sent to Official Account Messages by the cloud communication backend. For the specific format, refer to Message Format Description. |
CloudCustomData | String | Optional | 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). |
Was this page helpful?