跳到主要内容

好友关系状态变化回调

当用户的好友关系状态发生变更时,融云可将变更结果实时同步至您的应用服务器。

开通服务

调用本接口前,您需在控制台开通信息托管服务。详见开启用户信息托管

回调方法

请求方法:POST

数据格式application/json

融云 IM 服务端会在 POST 请求 URL 中添加签名参数,您可通过签名验证调用者身份和数据有效性,详见服务端回调签名

回调正文参数

回调服务的 HTTP 请求正文为 application/json 格式,包含如下字段:

参数类型必传说明
eventTypeNumber事件类型:
1 申请添加好友;
2 同意添加好友;
3 拒绝添加好友;
4 移除好友;
5 服务器直接添加好友
userIdString操作人用户 ID
toUserIdString对端用户 ID
timeLong操作时间戳
sourceString操作来源(如 Android、iOS、HarmonyOS、Websocket、PC、MiniProgram、Server 等)
extraString添加好友时携带的扩展数据

回调请求示例

假设您在服务配置页面设置的回调接收地址为 http://example.com/friend/sync.php,回调请求示例如下:

HTTP
POST /friend/sync HTTP/1.1
Host: example.com
Content-Type: application/json

{
"userId": "userId11",
"eventType": 3,
"toUserId": "toUserId22",
"source": "Android",
"extra": "XXXXXX",
"time": 1774363668900
}

响应回调请求

提示
  • 只要 HTTP 响应为 200 OK,服务端即认为状态已同步。
  • 若应答超时 5 秒,服务端会重试推送 2 次,若仍失败,则不再同步该状态。
  • 若短时间内大面积超时,将暂时停止请求您的服务器,1 分钟后继续发送回调。异常断网情况下会延迟 5 分钟同步。