即时通信 IM 添加好友之后回调 - 服务端 API

功能说明

App 后台可以通过该回调实时监控用户的新增好友信息。

注意事项

• 要启用回调，必须配置回调 URL，并打开本条回调协议对应的开关，配置方法详见 第三方回调配置 文档。
• 回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
• App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
• 其他安全相关事宜请参考 第三方回调简介：安全考虑 文档。

可能触发该回调的场景

• App 后台通过 REST API 发起加好友请求，请求添加双向好友，且对方的加好友验证方式是“允许任何人”。
• App 用户通过客户端发起加好友请求，请求添加双向好友，且对方的加好友验证方式是“允许任何人”。
• App 后台通过 REST API 发起加好友请求，请求添加单向好友。
• App 用户通过客户端发起加好友请求，请求添加单向好友。
• App 用户收到加好友请求后，同意添加对方为好友。
• App 后台通过 REST API 强制加好友。

回调发生时机

成功添加好友后触发。

注意：

通过调用 导入好友 接口添加好友时，不会触发此回调。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为 https://www.example.com。
示例：

https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

请求包示例

{
  "CallbackCommand": "Sns.CallbackFriendAdd",
  "PairList": [
      {
          "From_Account": "id",
          "To_Account": "id1",
          "Initiator_Account": "id"
      },
      {
          "From_Account": "id",
          "To_Account": "id2",
          "Initiator_Account": "id"
      },
      {
          "From_Account": "id",
          "To_Account": "id3",
          "Initiator_Account": "id"
      }
  ],
  "ClientCmd":"friend_add",
  "Admin_Account":"",
  "ForceFlag":1
}

请求包字段说明

应答包示例

{
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": ""
}

应答包字段说明

参考

• 第三方回调简介
• REST API：添加好友