通过该接口可以创建接收直播间,接口请求地址为:
https://api.csslcloud.net/api/room/rebroadcast/receivers
接口请求方法为:
xxxxxxxxxxPOST
接口加密方式:THQS加密
需要传递以下参数:
| 参数 | 说明 | 备注 |
| accountId | CC账户ID | 必选参数 |
| rebroadcastSenderId | 发起转播直播间ID | 必选参数 |
| rebroadcastReceivers | json-array格式的自定义转播接收直播间。 | 数组的个数为创建转播接收直播间的个数;个数限制为至少1、至多100. |
rebroadcastReceivers每一项说明:
| 参数 | 说明 | 备注 |
| name | 接收转播直播间名称 | 不可为空,最大字符40,标题头尾的空格字符会自动删除 |
| viewerAuth | 接收转播直播间的学员登陆验证方式 | 可选参数;为空时默认同发起转播直播间保持一致。不为空时,子项内容需正确填写 |
viewerAuth子项说明:
| 参数 | 说明 | 备注 |
| authType | 直播间学员观看验证方式 | 不可为空,可选值:api、singlePassword、passwordFree、whiteList |
| authValidateUrl | authType为api时,对应的接口验证地址 | authType为api时为必选参数; |
| authPassword | authType为singlePassword时,对应的密码 | authType为singlePassword时为必选参数; |
| authWhiteListId | authType为whiteList时,对应的白名单列表id | authType为whiteList时为必选参数 |
form-data格式的请求信息示例如下:
| key | value |
| accountId | C722A9A58CE4EF6D |
| rebroadcastSenderId | 5E653E99F39C6CF79C33DC5901307461 |
| rebroadcastReceivers | [{"name":"数学1","viewerAuth":{"authTypeStr":"singlePassword","authPassword":"671657"}},{"name":"数学2","viewerAuth":{"authTypeStr":"singlePassword","authPassword":"671657"}}] |
| time | 1647944058496 |
| hash | C6B97371A235D1D8088663BAB89AFE85 |
对hash字段的额外说明(具体可以参考:THQS加密文档)
返回数据包含如下字段:
| 字段名 | 说明 |
| success | 请求状态。true:成功;false:失败 |
| data | 请求结果 |
data包含如下字段:
| 字段名 | 说明 |
| rebroadcastReceivers | json-array格式的已创建的转播接收直播间信息 |
rebroadcastReceivers每一项包含如下字段:
| 字段名 | 说明 |
| id | 已创建的转播接收直播间ID |
| name | 已创建的转播接收直播间名称 |
JSON格式的返回信息示例如下:
xxxxxxxxxx{"success": true,"data": {"rebroadcastReceivers": [{"id":"188E0ED81ADF094C","name":"数学-1"}]}}