Skip to main content

Callback Before Setting Friend Remark

Function Description​

The App business server can use this callback to receive requests from users to set remarks for friends. Additionally, the business server can refuse the user's setting request or modify and intervene in the remark content.

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 set a friend's remark through the client.

Timing of the Callback​

  • Before OpenIM Server prepares to process the request to set a friend's remark.

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

Request Packet Example​

{
  "callbackCommand": "callbackBeforeSetFriendRemarkCommand",
  "ownerUserID": "user123",
  "friendUserID": "user456",
  "remark": "My Best Friend"
}

Request Packet Field Explanation​

FieldTypeDescription
callbackCommandstringCallback command, here for before setting friend remark
ownerUserIDstringUser ID of the person who initiated the remark setting operation
friendUserIDstringUser ID of the friend for whom the remark is set
remarkstringContent of the remark being set

Response Packet Example​

Allow Setting Remark​

Allows the user to set a friend's remark.

{
    "actionCode": 0,
    "errCode": 0,
    "errMsg": "Success",
    "errDlt": "",
    "nextCode": "0",
    "remark": "My Best Friend"
}

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 not 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.
remarkstringContent of the remark being set.