tencent cloud

功能说明

App 后台可以通过该回调实时查看用户上、下线的行为，包括：

• 用户上线（TCP 连接建立）
• 用户注销下线或者用户网络断开（TCP 连接断开）
• App 心跳超时（App 异常被 kill 或者 Crash）

注意事项

• 要启用回调，必须配置回调 URL，并打开本回调对应的开关，配置方法详见 第三方回调配置 文档。
• 回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
• App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
• 其他安全相关事宜请参考 第三方回调简介：安全考虑 文档。
• 使用终端 SDK 增强版5.6.1200之后的版本，或使用 Web SDK 2.14.0之后的版本时，因多终端登录或多实例登录被踢之后，只会触发一个 Login（Register）回调。而使用其他 SDK 版本的，当多终端登录或多实例登录被踢之后，会同时触发 Login（Register）回调和 Logout（Unregister）回调。

可能触发该回调的场景

• 用户通过客户端发起登录的上线请求。
• 用户通过客户端发起登出的下线请求。
• 用户的客户端发生断网重连。
• 用户主动 kill 客户端进程，或者切后台后进程被手机操作系统 kill 掉，或者 crash 导致进程异常退出，云服务器检测到客户端网络断开后触发网络断开回调。
• 客户端心跳超时，如关闭网络，或网络完全不可用，云服务器检测到客户端的心跳超时触发连接断开回调。心跳超时时间为 400 秒。

回调的实时性

Android/iOS/PC

对于绝大多数情况，用户状态的变化都能实时感知，从而实时地触发回调。例如：

• 用户主动登录，触发 Login（Register）回调。
• 用户主动登出，触发 Logout（Unregister）回调。
• 用户主动 kill 客户端进程，或者用户切后台后，客户端进程被手机操作系统 kill 掉，触发 Disconnect（LinkClose）回调。

只有以下一种特殊情况，IM 云服务器需要等待400秒的心跳超时时间才能感知状态变更：
当网络完全不可用时，客户端连 TCP 协议层的 FIN 包或 RST 包都无法发出时，IM 云服务器需要等待 400 秒的心跳超时时间才能触发 Disconnect（TimeOut）回调。常见的场景有用户主动关闭客户端的网络（例如开启手机的飞行模式），或者进入完全没有网络信号的隧道。

Web

用户主动登录 Web 端时，IM 云服务器可以实时触发 Login（Register）回调。

各种场景的退出/断线的状态变更回调实时性如下：

• 直接关闭页面，可以实时触发 Disconnect（LinkClose）回调。
• 页面不关闭时，网络断开，需要 60s 才能触发 Disconnect（LinkClose）回调。
• 主动调用 destroy 接口，可以实时触发 Logout（Unregister）回调。

小程序

用户主动登录小程序端时，IM 云服务器可以实时触发 Login（Register）回调。

各种场景的退出/断线的状态变更实时性如下：

• 点右上角退出，5s 内触发 Disconnect（LinkClose）回调。
• 断网(如手机开启飞行模式) ，60s 左右触发 Disconnect（LinkClose）回调。
• 微信切后台，30s 左右触发 Disconnect（LinkClose）回调。
• 杀掉微信进程，可以实时触发 Disconnect（LinkClose）回调。
• 主动调用 destroy 接口，可以实时触发 Logout（Unregister）回调。

接口说明

请求 URL 示例

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

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

请求参数说明

请求包示例

{
  "CallbackCommand": "State.StateChange",
  "EventTime": 1629883332497,
  "Info": {
      "Action": "Login",
      "To_Account": "testuser316",
      "Reason": "Register"
  },
  "KickedDevice": [
      {
          "Platform": "Windows"
      },
      {
          "Platform": "Android"
      }
  ]
}

请求包字段说明

应答包示例

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

应答包字段说明

参考

• 第三方回调简介
• 在线状态管理