Browse Platform API
Platform API

Before setting a friend remark

Copy

Validate or replace a friend remark.

HTTP request

POST {WEBHOOK_ADDRESS}/callbackBeforeSetFriendRemarkCommand

Request body

PropertyTypeDescription
callbackCommandstringcallbackBeforeSetFriendRemarkCommand.
ownerUserIDstringRelationship owner
friendUserIDstringFriend user ID
remarkstringProposed remark

Response

Return the common before-event response from Webhooks overview. Use nextCode: 1 to reject the operation.

Processing rules

  • Configuration key: beforeSetFriendRemark.
  • OpenIM waits synchronously; timeout behavior follows failedContinue.
  • The response may return remark to replace the pending value.