服务端 API

用户上线后

在用户建立在线连接后同步在线状态。

触发时机

项目	说明
类型	后置回调
配置项	`afterUserOnline`
回调命令	`callbackAfterUserOnlineCommand`

HTTP 请求

POST {WEBHOOK_ADDRESS}/callbackAfterUserOnlineCommand
Content-Type: application/json
operationID: {OPERATION_ID}

{
  "callbackCommand": "callbackAfterUserOnlineCommand",
  "operationID": "operation_001",
  "platformID": 1,
  "platform": "",
  "userID": "user_001",
  "seq": 1,
  "isAppBackground": false,
  "connID": ""
}

请求体参数

参数名	是否必填	类型	说明
callbackCommand	是	string	回调命令，值与当前页面的回调命令一致。
operationID	是	string	OpenIM 操作的链路追踪 ID。
platformID	是	int	客户端平台 ID，参见用户模块的 `PlatformID`。
platform	是	string	客户端平台名称。
userID	是	string	用户 ID。
seq	是	int	消息或连接序列号。
isAppBackground	是	boolean	客户端是否处于后台。
connID	是	string	连接 ID。

响应

业务服务端应返回 HTTP 成功状态和 JSON 响应体。

{
  "actionCode": 0,
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "nextCode": 0
}

响应参数

参数名	类型	说明
actionCode	int	处理状态，参见Webhooks 概述的 `CallbackAction`。
errCode	int	业务错误码；拒绝前置操作时返回业务约定的非零错误码。
errMsg	string	错误简要信息。
errDlt	string	错误详细信息。
nextCode	int	处理下一步，参见Webhooks 概述的 `CallbackNextCode`。

处理规则

事件发生后，OpenIM 异步调用该地址。
回调响应不能改变已经完成的 OpenIM 操作。
接收方应快速返回成功状态，再异步执行耗时业务。
接收方应按业务主键或 operationID 做幂等处理。

触发时机

HTTP 请求

请求体参数

响应

响应参数

处理规则

相关页面