Release Notes
Announcements
https://www.example.com.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 | Callback URL. |
SdkAppid | SDKAppID assigned to an application when the application is created in the Chat console. |
CallbackCommand | The value is fixed as Bot.OnGroupMessage. |
contenttype | The value is fixed as json. |
ClientIP | Client IP address. For example, 127.0.0.1. |
OptPlatform | Client platform. For the valid values, see the description of the OptPlatform parameter in Webhook Protocol in Webhook Overview. |
{"CallbackCommand": "Bot.OnGroupMessage", // Callback command."GroupId": "@TGS#2J4SZEAEL", // Group ID."Type": "Public", // Group type."From_Account": "jared", // Sender."Operator_Account":"admin", // Initiator of the request."Random": 123456, // Random number."MsgSeq": 123, // Message serial number."MsgTime": 1490686222, // Message sending timestamp."OnlineOnlyFlag": 1, // Online message. 1: yes; 0: no. For live streaming groups, this attribute is ignored, and the default value 0 is used."MsgBody": [ // Message body. See the message object TIMMessage.{"MsgType": "TIMTextElem", // Text."MsgContent": {"Text": "@@RBT#001 hello"}}],"AtRobots_Account": [ "@RBT#001" ], // List of reminded chatbots. Users can remind more than one chatbot if multiple chatbots exist in the group."CloudCustomData": "your cloud custom data","EventTime": 1670574414123// Event trigger timestamp, in milliseconds.}
Field | Type | Description |
CallbackCommand | String | Callback command. |
GroupId | String | ID of the group with the group message. |
Type | String | Type of the group with the group message. For example, Public. See Group Types in Group System for details. |
From_Account | String | User ID of the message sender. |
Operator_Account | String | User ID of the request initiator, which can be used to determine whether the request is initiated by the administrator. |
Random | Integer | 32-bit random number in the message request. |
MsgSeq | Integer | Message serial number, which uniquely identifies a message. Group messages are sorted by MsgSeq. A message is sent more recently if its MsgSeq value is larger. |
MsgTime | Integer | Message sending timestamp, corresponding to the backend server time. |
OnlineOnlyFlag | Integer | Online message. 1: yes; 0: no. For live streaming groups, this attribute is ignored, and the default value 0 is used. |
MsgBody | Array | |
AtRobots_Account | Array | List of reminded chatbots. Users can remind more than one chatbot if multiple chatbots exist in the group. |
CloudCustomData | String | Custom message data. (It is saved on the cloud and will be sent to the recipient. It can still be obtained after Chat is uninstalled and then reinstalled.) |
TopicId | String | Topic ID. If this parameter is used, messages are related to the topic. This parameter applies only to community groups that support topics. |
EventTime | Integer | Event trigger timestamp, in milliseconds. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // Ignore the callback result.}
Field | Type | Required | Description |
ActionStatus | String | Required | Request processing result. OK: processing successful; FAIL: processing failed. |
ErrorCode | Integer | Required | Error code. The value 0 indicates that the callback result is ignored. |
ErrorInfo | String | Required | Error message. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback