Callback After Sending Group Message

Functional Description

After a successful operation, the business server can perform necessary data synchronization or other business logic processing through this callback.

Precautions

• To enable the callback, you must configure the callback URL and turn on the switch corresponding to this callback protocol. See the Callback Description document for configuration methods.
• The callback direction is an HTTP/HTTPS POST request initiated by IMServer to the business server.
• The business server must respond to this request within the timeout period.

Scenarios That May Trigger This Callback

• After users perform corresponding operations successfully through the client or APP administrators through REST API.

Timing of Callback

• After a group chat message is successfully sent.

Interface Description

Request URL Example

Here CallbackCommand is: callbackAfterSendGroupMsgCommand

{WEBHOOK_ADDRESS}/callbackAfterSendGroupMsgCommand?contenttype=json

Request Package Example

{
  "sendID": "sender123",
  "callbackCommand": "callbackAfterSendGroupMsgCommand",
  "serverMsgID": "serverMsg123",
  "clientMsgID": "clientMsg123",
  "operationID": "1646445464564",
  "senderPlatformID": 1,
  "senderNickname": "JohnDoe",
  "sessionType": 2,
  "msgFrom": 1,
  "contentType": 1,
  "status": 1,
  "sendTime": 1673048592000,
  "createTime": 1673048592000,
  "content": "Hello, this is a group message!",
  "seq": 1,
  "atUserList": ["user456", "user789"],
  "faceURL": "http://example.com/path/to/sender/face/image.png",
  "ex": "Extra data",
  "groupID": "group123"
}

Request Package Field Description

Object	Type	Description
sendID	string	Unique identifier of the sender
callbackCommand	string	Callback command, here it is the callback after sending a group message
serverMsgID	string	Message ID generated by the server
clientMsgID	string	Message ID generated by the client
operationID	string	Unique identifier for the operation
senderPlatformID	int32	Platform ID of the sender
senderNickname	string	Nickname of the sender
sessionType	int32	Session type
msgFrom	int32	Message source
contentType	int32	Type of message content
status	int32	Message status
sendTime	int64	Timestamp of message sending (milliseconds)
createTime	int64	Timestamp of message creation (milliseconds)
content	string	Message content
seq	uint32	Sequence number of the message
atUserList	array	List of group member IDs
senderFaceURL	string	Avatar URL of the sender
ex	string	Extra data field
groupID	string	Unique identifier of the group

Response Package Example

Successful Response

After the App business server synchronizes data, it sends a callback response package

{
    "actionCode": 0,
    "errCode": 0,
    "errMsg": "",
    "errDlt": "",
    "nextCode": ""
}

Response Package Field Description

Field	Value	Description
actionCode	0	Indicates whether the business system callback was executed correctly. 0 means the operation was successful.
errCode	0	Custom error code, 0 here means ignore the callback result.
errMsg	"An error message"	Simple error message corresponding to the custom error code.
errDlt	"Detailed error information"	Detailed error information corresponding to the custom error code.
nextCode	1	Next execution instruction, 1 means refusing to continue execution, set when actionCode is 0.