跳到主要内容

设置好友备注后的回调

功能说明​

App 业务服务端可以通过该回调获取用户设置好友备注的操作结果，App 后台可以据此进行数据同步等操作。

注意事项​

  • 为启用回调，必须配置回调 URL，并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
  • 回调的方向是 OpenIM Server 向 App 后台发起 HTTP/HTTPS POST 请求。
  • APP 业务服务端需在超时时间内响应此请求。

可能触发该回调的场景​

  • App 用户通过客户端设置好友备注。
  • App 管理员通过 REST API 设置好友备注。

回调发生时机​

  • OpenIM Server 处理完设置好友备注的请求之后。

接口说明​

请求 URL 示例​

此处CallbackCommand为：callbackAfterSetFriendRemarkCommand

{WEBHOOK_ADDRESS}/callbackAfterSetFriendRemarkCommand?contenttype=json

请求包示例​

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

请求包字段说明​

字段类型描述
callbackCommandstring回调命令，这里是设置好友备注后的回调
ownerUserIDstring执行设置备注操作的用户 ID
friendUserIDstring备注设置对象的好友用户 ID
remarkstring设置的备注内容

应答包示例​

操作成功​

操作成功的应答示例。

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

应答包字段说明​

字段值说明
actionCode0表示业务系统的回调是否正确执行。0表示操作成功。
errCode20001表示自定义错误码，范围在 20001-29999 之间。在 actionCode 不等于 0 时设置；在 nextCode 等于 1 时设置。
errMsg"An error message"自定义错误码对应的简单错误信息。
errDlt"Detailed error information"自定义错误码对应的详细错误信息。
nextCode1下一步执行指令，1表示拒绝继续执行，actionCode 等于0时设置。