添加节目到节目单中。
接口说明
请先创建新播单型导播台,添加新播单型导播台视频资源后再调用本接口添加导播台节目到节目单中。使用 API 创建导播台,请参见创建导播台。
每个节目单最多可添加 1000 个节目。
-
使用视频点播(VOD)资源,可优先选择托管 Bucket 资源,自有 Bucket 资源存在过期风险,如果您选用自有 Bucket 资源,需注意资源的有效期时间。
-
导播台素材资源输入请优先选择视频直播和视频点播的资源,若从第三方 URL 输入资源存在播放失败可能性,需确定资源的质量和有效性。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:AddShowIntoShowList |
create |
*Caster
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
showList |
array<object> |
否 |
需要添加的多个节目资源列表,每个资源都有独立的 showName,resourceUrl 等参数。 |
|
object |
否 |
导播台列表信息。 |
||
duration |
integer |
否 |
单个节目播放时间长度,单位:秒。 说明
RepeatTimes 和 Duration 两者只允许设置其中一个。 |
20 |
liveInputType |
integer |
否 |
自定义的类型标记。 |
1 |
repeatTimes |
integer |
否 |
单个节目播放循环次数,默认为 0。 说明
|
0 |
resourceId |
string |
否 |
点播文件 ID。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
resourceType |
string |
否 |
素材类型。取值:
说明
|
vod |
resourceUrl |
string |
否 |
播放文件 URL。 |
http://****/atestObject****.m3u8 |
showName |
string |
否 |
节目名称。 |
liveShow**** |
CasterId |
string |
是 |
导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
ShowName |
string |
否 |
节目名称。 |
liveShow**** |
ResourceType |
string |
否 |
素材类型。取值:
说明
|
vod |
ResourceUrl |
string |
否 |
播放文件 URL。 |
http://****/atestObject****.m3u8 |
ResourceId |
string |
否 |
点播文件 ID。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
Duration |
integer |
否 |
单个节目播放时间长度,单位:秒。 说明
RepeatTimes 和 Duration 两者只允许设置其中一个。 |
20 |
RepeatTimes |
integer |
否 |
单个节目播放循环次数,默认为 0。 说明
|
0 |
Spot |
integer |
否 |
插入到播放列表的位置。位置从 0 开始,默认添加到当前节目单的末尾。 |
1 |
LiveInputType |
integer |
否 |
自定义的类型标记。 |
1 |
isBatchMode |
boolean |
否 |
是否批量添加节目到节目单。取值:
说明
该参数不填,取值为空时,也表示单个添加。 |
false |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 ID。 |
987DA143-A39C-5B5D-AF5B-3B07944A0036 |
ShowId |
string |
节目 ID。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
failedList |
string |
添加失败的资源列表以及失败原因信息。 |
failedList[Show1, Show2...] |
successfulShowIds |
string |
添加成功添加的节目 ID 列表。 |
f1933f16-5467-4308-b3a9-e8d451a90999,547436b8-c839-4469-a2c0-704c1ce5ce00 |
示例
正常返回示例
JSON
格式
{
"RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036",
"ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"failedList": "failedList[Show1, Show2...]",
"successfulShowIds": "f1933f16-5467-4308-b3a9-e8d451a90999,547436b8-c839-4469-a2c0-704c1ce5ce00"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidUserId.Malformed | %s | |
400 | InvalidParameter.Malformed | %s | |
400 | InvalidCasterId.Malformed | %s | |
400 | InvalidVodUrl.Malformed | %s | |
400 | MissingParameter | %s | |
401 | IllegalOperation | %s | |
500 | InternalError | %s | |
404 | InvalidCaster.NotFound | %s | |
404 | InvalidShowList.NotFound | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。