设置预习课件
更新时间:2022-12-28
接口描述
将直播间关联的文档设置为预习课件
说明:设置预习课件必须是已经关联直播间的文档,一个直播间只能设置一个预习文档
请求地址
https://ccapi.csslcloud.net/openapi/v1/doc/preview/set
请求方式
GET
请求参数
接口统一权限认证请参考THQS认证方式。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
accountId | String | 是 | 开发者账号ID |
roomId | String | 是 | 直播间ID |
docId | String | 是 | 文档ID |
preview | Integer | 是 | 预习课件标识,取值说明:0为非预习课件,1为预习课件,取值范围:[0,1] |
请求示例
GET https://ccapi.csslcloud.net/openapi/v1/doc/preview/set?accountId=41E8063FC799ACE&roomId=D90DCF5BF6DA3C8C9C33DC5901307461&docId=0A0833E541533352&preview=1&time=1670412086&hash={hash}
返回数据
公共返回数据结构请参考 公共返回数据说明。
名称 | 类型 | 描述 |
---|---|---|
result | String | 返回状态:OK为成功,FAIL为失败 |
返回示例
{
"result": "OK"
}