Skip to content
Permalink
Fetching contributors…
Cannot retrieve contributors at this time
96 lines (73 sloc) 3.03 KB

功能说明

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

注意事项

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

可能触发该回调的场景

  • App 用户通过客户端发起删除好友的请求。
  • App 后台通过 REST API 发起删除好友的请求。

回调发生时机

即时通信 IM 后台收到删除好友请求,删好友成功后。

接口说明

请求 URL 示例

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

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

请求参数说明

参数 说明
https 请求协议为 HTTPS,请求方式为 POST
www.example.com 回调 URL
SdkAppid 创建应用时在即时通信 IM 控制台分配的 SDKAppID
CallbackCommand 固定为 Sns.CallbackFriendDelete
contenttype 固定值为 JSON
ClientIP 客户端 IP,格式如:127.0.0.1
OptPlatform 客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义

请求包示例

{
    "CallbackCommand": "Sns.CallbackFriendDelete", 
    "PairList": [
        {
            "From_Account": "id", 
            "To_Account": "id1"
        }, 
        {
            "From_Account": "id", 
            "To_Account": "id2"
        }, 
        {
            "From_Account": "id", 
            "To_Account": "id3"
        }
    ]
}

请求包字段说明

字段 类型 说明
CallbackCommand String 回调命令
PairList Array 成功删除的好友
From_Account String From_Account 的好友表中删除了 To_Account
To_Account String To_Account 从 From_Account 的好友表中删除

应答包示例

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

应答包字段说明

字段 类型 属性 说明
ActionStatus String 必填 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode Integer 必填 错误码,0表示 App 后台处理成功,1表示 App 后台处理失败
ErrorInfo String 必填 错误信息

参考

You can’t perform that action at this time.