Skip to main content

Callback for Removing a User from the Blacklist

Function Description​

The App business server can use this callback to process user requests for removing someone from the blacklist. This includes real-time recording of users leaving the blacklist (e.g., logging or syncing to other systems).

Precautions​

  • To enable the callback, it is necessary to configure the callback URL and activate the corresponding switch for this callback protocol. Configuration methods can be found in the Callback Explanation document.
  • The direction of 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 is its SDKNAME parameter.
  • The APP business server must respond to this request within the timeout period.

Scenarios That May Trigger This Callback​

  • App users try to remove other users from the blacklist through the client.

Timing of the Callback​

  • After OpenIM Server receives a request to remove a user from the blacklist, but before processing the request.

Interface Description​

Request URL Example​

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

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

Request Parameter Description​

ParameterDescription
httpsRequest protocol is HTTPS, method is POST
https://callbackurlCallback URL
CallbackCommandFixed value: removeBlackCommand
contenttypeFixed value: JSON
Header NameExample ValueMandatoryTypeDescription
operationID1646445464564RequiredstringoperationID for global link tracing

Request Packet Example​

{
  "callbackCommand": "removeBlackCommand",
  "ownerUserID": "user123",
  "blackUserID": "user456"
}

Request Packet Field Explanation​

FieldTypeDescription
callbackCommandstringCallback command, here for removing a user from the blacklist
ownerUserIDstringUser ID of the person initiating the remove request
blackUserIDstringUser ID of the person being removed from the blacklist

Response Packet Example​

Allow Removal​

Allows the user to remove the specified user from the blacklist.

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

Response Packet Field Explanation​

FieldValueDescription
actionCode0Indicates if the business system's callback was executed correctly. 0 means the operation was successful.
errCode0Custom 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.
nextCode1Next step instruction, 1 means to refuse to continue executing, set when actionCode is 0.