Skip to main content

Callback for Adding a User to the Blacklist

Function Description​

The App business server can use this callback to receive requests from users who are attempting to add other users to their blacklist. The business server can review or modify these requests as needed.

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 OpenIMServer 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 add other users to the blacklist through the client.

Timing of the Callback​

  • After OpenIMServer receives a request to add a user to 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: addBlackCommand
contenttypeFixed value: JSON
Header NameExample ValueMandatoryTypeDescription
operationID1646445464564RequiredstringoperationID for global link tracing

Request Packet Example​

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

Request Packet Field Explanation​

FieldTypeDescription
callbackCommandstringCallback command, here for adding a user to the blacklist
ownerUserIDstringUser ID of the person initiating the blacklist addition
blackUserIDstringUser ID of the person being added to the blacklist

Response Packet Example​

Allow Adding​

Allows the user to add the specified user to the blacklist.

{
  "actionCode": 0,
  "errCode": 0,
  "errMsg": "Success",
  "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.