Callback After Setting Group Member Information

Function Description

The App business server can use this callback to obtain requests for setting group member information, allowing the App to perform necessary data synchronization.

Precautions

• To enable the callback, it is required to configure the callback URL and turn on the switch corresponding to this callback protocol. For configuration methods, see the Callback Explanation document.
• The callback is an HTTP/HTTPS POST request initiated by OpenIM Server to the App backend.
• After receiving the callback request, the App business server must verify whether the command parameter in the request URL matches its SDKNAME parameter.
• The APP business server must respond to this request within the timeout period.

Scenarios That May Trigger This Callback

• Group administrators successfully modify group member-related information through the client.

Timing of the Callback

• After OpenIM Server updates group member information.

Interface Description

Request URL Example

In the following example, the App's configured callback URL is https://callbackurl.

https://callbackurl?command=$CallbackCommand&contenttype=json

Request Parameter Description

Parameter	Description
https	Request protocol is HTTPS, method is POST
https://callbackurl	Callback URL
CallbackCommand	Fixed value: callbackAfterSetGroupMemberInfoCommand
contenttype	Fixed value: JSON

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	operationID for global link tracking

Request Packet Example

{
  "callbackCommand": "callbackAfterSetGroupMemberInfo",
  "groupID": "12345",
  "userID": "user789",
  "nickName":"user",
  "faceURL": "http://example.com/path/to/face/image.png",
  "roleLevel": 20,
  "ex": "Extra data"
}

Request Packet Field Explanation

Field	Type	Description
callbackCommand	string	Callback command, here for the callback after setting group member info
groupID	string	Unique identifier of the group
userID	string	ID of the user joining the group
nickName	string	Nickname of the user joining the group
faceURL	string	URL of the group member's icon
roleLevel	string	Role level of the user in the group. Normal member (20) or administrator (60)
ex	string	Additional data field

Response Packet Example

After synchronizing data, the App backend sends a callback response packet.

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

Response Packet Field Explanation

Field	Value	Description
actionCode	0	Indicates whether the business system's callback is executed correctly. 0 means the operation is successful.
errCode	0	Indicates a custom error code, here 0 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 step instruction, 1 means refuse to continue executing, set when actionCode is 0.