Callback for Kicking Out Group Members
Function Description
The App business server can use this callback to handle requests from group administrators to kick out members, including real-time recording of members leaving the group (such as logging or synchronizing with other systems).
Precautions
- To enable the callback, you must configure the callback URL and activate the switch corresponding to this callback protocol. See the Callback Description document for configuration methods.
- The direction of the callback is an HTTP/HTTPS POST request initiated by OpenIM Server to the App backend.
- The App business server needs to verify whether the command parameter in the request URL is its own SDKNAME parameter after receiving the callback request.
- The APP business server is required to respond to this request within the timeout period.
Scenarios That May Trigger This Callback
- Group administrators or owners attempt to kick out one or more group members through the client.
Timing of the Callback
- After OpenIM Server receives a request to kick out group members and before processing the request.
Interface Description
Request URL Example
In the following example, the configured callback URL of the App is https://callbackurl
.
https://callbackurl?command=$CallbackCommand&contenttype=json
Request Parameter Description
Parameter | Description |
---|---|
https | Request protocol is HTTPS, request method is POST. |
https://callbackurl | Callback URL |
CallbackCommand | Fixed value: kickGroupMemberCommand |
contenttype | Fixed value: JSON |
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | operationID used for global tracing |
Request Packet Example
{
"callbackCommand": "kickGroupMemberCommand",
"groupID": "G001",
"kickedUserIDs": ["user123", "user456"],
"reason": "Violation of group rules"
}
Request Packet Field Description
Field | Type | Description |
---|---|---|
callbackCommand | string | Callback command, here for kicking out group members. |
groupID | string | Unique identifier of the group. |
kickedUserIDs | []string | List of user IDs of the members being kicked out. |
reason | string | Reason for kicking out members. |
Response Packet Example
Allowing the Kick Out
Allowing the specified group members to be kicked out.
{
"actionCode": 0,
"errCode": 0,
"errMsg": "Success",
"errDlt": "",
"nextCode": "nextCodeValue"
}
Response Packet Field Description
Field | Value | Description |
---|---|---|
actionCode | 0 | Indicates whether the business system's callback was executed correctly. 0 means the operation was successful. |
errCode | 0 | Represents a custom error code, here 0 indicates ignoring 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 refuse to continue execution, set when actionCode is 0 . |