Skip to main content

Callback After Group Dissolution

Description​

The App’s business server can use this callback to receive information on group dissolutions, enabling it to record such events in real-time (e.g., logging or syncing with other systems).

Important Notes​

  • To enable this callback, configure the callback URL and activate the corresponding protocol switch. For configuration details, refer to the Callback Introduction document.
  • The callback is initiated from the OpenIM Server to the App backend as an HTTP/HTTPS POST request.
  • The App business server must respond within the timeout period.

Scenarios that Trigger This Callback​

  • Group dissolution initiated by an App user through the client.
  • Group dissolution initiated by an App admin via REST API.

Timing of Callback​

  • Triggered after the group is dissolved.

Interface Description​

Example Request URL​

The CallbackCommand here is: callbackAfterDisMissGroupCommand

{WEBHOOK_ADDRESS}/callbackAfterDisMissGroupCommand?contenttype=json

Example Request Package​

{
  "callbackCommand": "callbackAfterDisMissGroupCommand",
  "groupID": "G001",
  "groupType": 2,
  "ownerID": "user123",
  "membersID": ["user456", "user789"]
}

Request Package Field Descriptions​

FieldTypeDescription
callbackCommandstringCallback command for post-group dissolution.
groupIDstringUnique identifier for the group.
groupTypeint32Group type, fixed at 2.
ownerIDstringUser ID of the group owner.
membersIDarrayList of member user IDs present at dissolution.

Example Response Package​

Handling Outcome​

After recording the group dissolution information, the App backend sends the response package.

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

Response Package Field Descriptions​

FieldValueDescription
actionCode0Indicates if the callback was executed correctly. 0 means success.
errCode0Custom error code, set to 0 to ignore callback results.
errMsg"An error message"Simple error message for the custom error code.
errDlt"Detailed error information"Detailed error information for the custom error code.
nextCode1Next action code, set to 1 to halt further action if actionCode is 0.