功能说明
您的 App 后台可以通过该回调实时查看用户上麦的信息,包括:App 后台用户上麦成功通知时,可以据此进行数据同步等操作。
注意事项
要启用回调,必须配置回调 URL,并打开本条命令字的开关,请参考 回调命令字的创建。
回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
可能触发该回调的场景
App 用户通过客户端用户上麦成功。
App 管理员通过 REST API 用户上麦成功。
回调的发生时机
用户上麦成功之后。
接口说明
请求URL
以下示例中 App 配置的回调 URL 为
https://www.example.com
。
示例:$http://www.example.com?sdkappid=$sdkappid&command=$command&contenttype=json&clientip=$clientip&optplatform=$optplatform
请求参数说明
参数 | 说明 |
http | 请求协议为 HTTPS 或 HTTP,请求方式为 POST |
www.example.com | 回调 URL |
sdkappid | 创建应用时在即时通信 IM 控制台分配的 SDKAppID |
command | 固定为 takeSeat |
contenttype | 固定值为 json |
clientip | 客户端 IP,格式如:127.0.0.1, 如果是 RestApi 调用地址为0.0.0.0 |
optplatform | 客户端平台,可能是 Android、iOS、Windows、MacOS、Unknown,若 RestApi 发送的请求,optplatform 为rest_api |
具体的回调内容在 HTTP 请求包体中,参见下文回调示例。
回调示例
回调请求示例:
POST /?sdkappid=8888888&command=takeSeat&contenttype=json&clientip=127.0.0.1&optplatform=iOS HTTP/1.1Host: www.example.comContent-Length: 337{"SeatCount": 5, // 当前的麦位数量"UserId": "Alice", // 操作用户id"RoomId": "Alice's Room", // 操作房间id"EventTime": 1682415761579 //毫秒级别,事件触发时间戳}
回调应答示例:
App 后台同步数据后,发送回调应答包。
{"ErrorCode": 0, // 0 为成功,其余为失败"ErrorMessage": "Success", // 失败原因}