浏览 平台 API
服务端 API

发起好友申请前

复制

在发起好友申请前执行权限或风控校验。

触发时机

项目说明
类型前置回调
配置项beforeAddFriend
回调命令callbackBeforeAddFriendCommand

HTTP 请求

POST {WEBHOOK_ADDRESS}/callbackBeforeAddFriendCommand
Content-Type: application/json
operationID: {OPERATION_ID}
{
  "callbackCommand": "callbackBeforeAddFriendCommand",
  "fromUserID": "user_001",
  "toUserID": "user_001",
  "reqMsg": "申请说明",
  "ex": ""
}

请求体参数

参数名是否必填类型说明
callbackCommandstring回调命令,值与当前页面的回调命令一致。
fromUserIDstring发起操作的用户 ID。
toUserIDstring目标用户 ID。
reqMsgstring好友申请附言。
exstring业务扩展字段。

响应

业务服务端应返回 HTTP 成功状态和 JSON 响应体。

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

响应参数

参数名类型说明
actionCodeint处理状态,参见Webhooks 概述的 CallbackAction
errCodeint业务错误码;拒绝前置操作时返回业务约定的非零错误码。
errMsgstring错误简要信息。
errDltstring错误详细信息。
nextCodeint处理下一步,参见Webhooks 概述的 CallbackNextCode

处理规则

  • OpenIM 同步等待业务服务端响应。
  • 返回 nextCode: 0 时继续原流程;返回 nextCode: 1 时,OpenIM 使用响应中的错误信息终止本次操作。
  • 请求失败或超时后的行为由该回调的 failedContinue 配置决定。
  • 响应中的业务字段仅在对应字段存在时覆盖 OpenIM 即将处理的数据。

相关页面