功能说明
App 后台可以通过该回调实时查看麦位列表变更消息。
注意事项
要启用回调,必须配置回调 URL,并开启本条回调协议对应的开关,回调功能需要自行在控制台配置,详细操作步骤可参见 控制台回调配置 。
回调的方向是 Live 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
可能触发该回调的场景
App 用户上下麦。
操作麦位锁定。
回调发生时机
麦位信息变更之后。
接口说明
请求 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 | 固定为 Mic.CallbackAfterSeatInfoChanged。 |
contenttype | 固定值为 json。 |
ClientIP | 客户端 IP,格式如: 127.0.0.1。 |
OptPlatform |
请求包示例
{"CallbackCommand":"Mic.CallbackAfterSeatInfoChanged","RoomId":"rid-123","SeatList":[{// 麦位编号"Index": 1,// 如果当前麦位有人占用,则返回对应用户的 ID, 否则该字段不会设置"Member_Account": "user2",// false:允许上麦 true:禁止上麦"IsTakenDisabled": false,// false:允许推视频流 true:禁止推视频流"IsVideoDisabled": false,// false:允许推音频流 true:禁止推音频流"IsAudioDisabled": false}],"EventTime":1670574414123//毫秒级别,事件触发时间戳}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令。 |
RoomId | String | 房间 ID。 |
SeatList | Array | 麦位列表。 |
Index | Integer | 麦位号。 |
Member_Account | String | 麦位上的用户 ID,如果该麦没有用户,则无此字段。 |
IsTakenDisabled | Bool | 麦位锁定。 |
IsVideoDisabled | Bool | 禁止麦位视频流。 |
IsAudioDisabled | Bool | 禁止麦位音频流。 |
EventTime | Integer | 事件触发的毫秒级别时间戳。 |
应答包示例
App 后台同步数据后,发送回调应答包。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // 忽略回调结果}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果,OK 表示处理成功,FAIL 表示失败。 |
ErrorCode | Integer | 必填 | 错误码,此处填0表示忽略应答结果。 |
ErrorInfo | String | 必填 | 错误信息。 |
参考
第三方回调简介