导入好友之后的回调
功能说明
App 业务服务端可以通过该回调获取用户导入好友的请求,同时业务服务端可以拒绝用户导入好友的请求,或对请求做修改和干预。
注意事项
- 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
- 回调的方向是 OpenIM Server 向 App 后台发起 HTTP/HTTPS POST 请求。
- APP 业务服务端需在超时时间内响应此请求。
可能触发该回调的场景
- App 用户通过客户端导入好友。
- App 管理员通过 REST API 导入好友。
回调发生时机
- OpenIM Server 准备导入好友之前。
接口说明
请求 URL 示例
此处CallbackCommand
为:callbackBeforeImportFriendsCommand
{WEBHOOK_ADDRESS}/callbackBeforeImportFriendsCommand?contenttype=json
请求包示例
{
"callbackCommand": "callbackBeforeImportFriendsCommand",
"ownerUserID": "user123",
"friendUserIDs": ["user456", "user789"]
}
请求包字段说明
字段 | 类型 | 描述 |
---|---|---|
callbackCommand | string | 回调命令,这里是导入好友之前的回调 |
ownerUserID | string | 发起导入好友请求的用户 ID |
friendUserIDs | array | 要导入为好友的用户 ID 列表 |
应答包示例
允许导入
允许用户导入好友。
{
"actionCode": 0,
"errCode": 0,
"errMsg": "",
"errDlt": "",
"nextCode": "0"
}
拒绝导入
拒绝用户导入好友,并提供错误信息。
{
"actionCode": 1,
"errCode": 5001,
"errMsg": "User not allowed to import friends",
"errDlt": "The user does not meet the criteria for importing friends",
"nextCode": "1"
}
应答包字段说明
字段 | 值 | 说明 |
---|---|---|
actionCode | 0 | 表示业务系统的回调是否正确执行。0 表示操作成功。 |
errCode | 0 | 表示自定义错误码,此处填 0 代表忽略回调结果。 |
errMsg | "An error message" | 自定义错误码对应的简单错误信息。 |
errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。 |
nextCode | 1 | 下一步执行指令,1 表示拒绝继续执行,actionCode 等于0 时设置。 |