创建回调配置
功能说明
App 管理员可以通过该接口创建回调配置。
接口调用说明
请求 URL 示例
https://console.tim.qq.com/v4/live_config/set_callback?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/live_config/set_callback | 请求接口 |
sdkappid | 创建应用时在 Chat 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
创建房间
{"Url":"http://www.example.com/callback","CallbackCommandList":["Live.CallbackAfterCreateRoom","Live.CallbackAfterDestroyRoom","Live.CallbackAfterMemberStateChanged"]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
Url | String | 必填 | 回调的地址,需要以 http/https 开头,建议使用更为安全的 https |
CallbackCommandList | Array | 必填 |
应答包体示例
基础形式
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
RequestId | String | 唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 含义说明 |
100001 | 服务器内部错误,请重试 |
100002 | 参数非法,请根据错误描述检查请求是否正确。 |
100300 | 回调配置已存在,可以使用更新回调配置接口进行更新 |