sendmsg
RESTful API.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](http://www.example.com) | Callback URL |
SdkAppid | The SDKAppID assigned by the Chat console when the app is created |
CallbackCommand | The value is always C2C.CallbackBeforeSendMsg . |
contenttype | Always json |
ClientIP | Client IP, such as 127.0.0.1 |
OptPlatform | Client platform. For valid values, see the description of OptPlatform in the Webhook Protocols section of Webhook Overview. |
{"CallbackCommand": "C2C.CallbackBeforeSendMsg", // Webhook command"From_Account": "jared", // Sender"To_Account": "John", // Recipient"MsgSeq": 48374, // Sequence number of the message"MsgRandom": 2837546, // Random number of the message"MsgTime": 1557481126, // Timestamp in seconds indicating when the message is sent"MsgKey": "48374_2837546_1557481126", // Unique identifier of the message. It can be used to recall the message via a RESTful API call."OnlineOnlyFlag":1, // The value is `1` if it is an online message and `0` if it's not"MsgBody": [ // Message body. For more information, see the `TIMMessage` message object.{"MsgType": "TIMTextElem", // Text"MsgContent":{"Text": "red packet"}}],"CloudCustomData": "your cloud custom data"}
Field | Type | Description |
CallbackCommand | String | Webhook command |
From_Account | String | UserID of the message sender |
To_Account | String | UserID of the message recipient |
MsgSeq | Integer | Sequence number of the message. It is used to identify the message and the value is a random 32-bit unsigned integer. |
MsgRandom | Integer | Random number of the message. It is used to identify the message and the value is a random 32-bit unsigned integer. |
MsgTime | Integer | Timestamp in seconds indicating when the message is sent. One-to-one messages are preferentially sorted by MsgTime . Messages sent in the same second are sorted by MsgSeq . Messages with larger values of MsgSeq are after those with smaller values. |
MsgKey | String | |
OnlineOnlyFlag | Integer | The value is 1 if it is an online message and 0 if it's not. |
MsgBody | Array | |
CloudCustomData | String | Custom message data. It is saved in the cloud and will be sent to the receiver. Such data can be pulled after the app is uninstalled and reinstalled. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // `0` indicates the user is allowed to send messages.}
20006
is returned to the user (message sender).{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 1 // `1` indicates that the user is not allowed to send messages.}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 2 // The value `2` indicates the message is silently discarded.}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0, // This field must be set to `0` so that the modified message can be sent normally."MsgBody": [ // Message modified by the app backend. If the app backend does not modify the message, the message sent by the user is delivered.{"MsgType": "TIMTextElem", // Text"MsgContent":{"Text": "red packet"}},{"MsgType": "TIMCustomElem", // Custom message"MsgContent":{"Desc": " CustomElement.MemberLevel ", // Description"Data": " LV1" // Data}}],"CloudCustomData": "your new cloud custom data" // Custom message data}
Field | Type | Required | Description |
ActionStatus | String | Yes | Request result. OK : Successful; FAIL : Failed |
ErrorCode | Integer | Yes | Error code returned. 0 : allows message sending; 1 : forbids message sending; 2 : discards the message silently. If the business side wants to forbid a user to send messages and send ErrorCode and ErrorInfo to the client, ensure that the value of ErrorCode is set within the range of [120001, 130000]. |
ErrorInfo | String | Yes | Error information |
MsgBody | Array | No | Message body modified by the app backend. The Chat backend sends the modified message to the recipient. For more information on the format, see Message Formats. |
CloudCustomData | String | No | Custom message data modified by the app backend. It is saved in the cloud and will be sent to the peer end. Such data can be pulled after the app is uninstalled and reinstalled. The Chat backend sends the modified message to the recipient. |
문제 해결에 도움이 되었나요?