Skip to main content

Callback Before Adding a Friend

Function Description​

The App business server can use this callback to receive user requests for adding friends, including:

  • Real-time monitoring of friend request submissions.
  • Intercepting malicious friend requests.

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 send friend requests through the client, asking to add friends.

Timing of the Callback​

  • After OpenIM Server receives a friend request from the APP.

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: callbackBeforeAddFriendCommand
contenttypeFixed value: JSON
Header NameExample ValueMandatoryTypeDescription
operationID1646445464564RequiredstringoperationID for global link tracing

Request Packet Example​

{
  "callbackCommand": "callbackBeforeAddFriendCommand",
  "fromUserID": "user123",
  "toUserID": "user456",
  "reqMsg": "Hi, let's be friends!"
}

Request Packet Field Explanation​

FieldTypeDescription
callbackCommandstringCallback command, here for before adding a friend
fromUserIDstringUser ID of the person initiating the friend request
toUserIDstringUser ID of the person receiving the friend request
reqMsgstringAdditional message sent with the friend request

Response Packet Example​

Allow Adding​

Allows the user to add a friend.

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

Response Packet Field Explanation​

FieldValueDescription
actionCode0Indicates if the business system's callback was executed correctly. 0 means the operation was successful.
errCode5001Custom error code, ranging between 5000-9999. Set when actionCode is not 0; set when nextCode is 1.
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.