调用AddPlaylistItems添加节目单项_视频直播(LIVE)-阿里云帮助中心

使用说明

先创建导播台，添加导播台布局和导播台组件，再调用本接口添加节目单项。若没有创建过节目单，则直接创建。使用API创建导播台请参考创建导播台。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	AddPlaylistItems	系统规定参数。取值：AddPlaylistItems。
CasterId	String	是	0e94d1f4-1a65-445c-9dcf-de8b3b8d****	导播台ID。如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。说明直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。导播台需满足如下配置： NormType：3。您需要提前创建好轻量级轮播型的导播台，可以调用CreateCaster接口创建导播台。 CasterTemplate：lp_noTranscode。 channelEnable：0。 programEffect：1。
ProgramItems	String	是	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]	节目单项输入列表。为JSON字符串，更多信息，请参见InputProgramItem。
ProgramId	String	否	445409ec-7eaa-461d-8f29-4bec2eb9****	节目单ID。不填则默认创建一个新的节目单。
ProgramConfig	String	否	[{"RepeatNumber":"0","ProgramName":"my program"}]	节目单项配置。若首次添加，传该参数进行初始化配置。更多信息，请参见ProgramConfig。

InputProgramItem

参数名称	示例值	类型	描述
ItemName	item1	String	节目单项名称。
ResourceType	vod	String	资源类型。取值： vod：阿里云视频点播资源。 url：第三方视频资源。
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	当ResourceType为vod时，ResourceValue为媒资ID。当ResourceType为url时，ResourceValue为第三方视频URL。

ProgramConfig

参数名称	示例值	类型	描述
RepeatNumber	0	Integer	播放完后重复继续播放的次数。取值： 0（默认值）：不重复播放。 -1：一直循环重复。其他正整数：播放完后重复继续播放的次数。
ProgramName	myprogram	String	节目单名称。

参数名称

示例值

类型

描述

RepeatNumber

0

Integer

播放完后重复继续播放的次数。取值：

0（默认值）：不重复播放。

-1：一直循环重复。

其他正整数：播放完后重复继续播放的次数。

ProgramName

myprogram

String

节目单名称。

返回数据

名称	类型	示例值	描述
ProgramId	String	445409ec-7eaa-461d-8f29-4bec2eb9****	节目单ID。可作为删除节目单项，查询节目单项，编辑节目单，删除节目单，查询节目单，启动节目单，停止节目单的请求参数。
RequestId	String	5c6a2a0d-f228-4a64-af62-20e91b96****	请求ID。
Items	Object		添加节目单项信息列表。
SuccessItems	Array of SuccessItem		添加成功的节目单项列表。
ItemName	String	item2	节目单项名称。
ItemId	String	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	节目单项ID。
FailedItems	Array of FailedItem		添加失败的节目单项列表。
ItemName	String	item1	节目单项名称。
ItemId	String	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	节目单项ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddPlaylistItems
&CasterId=0e94d1f4-1a65-445c-9dcf-de8b3b8d****
&ProgramItems=[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}]
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AddPlaylistItemsResponse>
    <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>
    <Items>
        <FailedItems>
            <ItemName>item2</ItemName>
            <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>
        </FailedItems>
        <SuccessItems>
            <ItemName>item2</ItemName>
           <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>
        </SuccessItems>
    </Items>
    <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>
</AddPlaylistItemsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5c6a2a0d-f228-4a64-af62-20e91b96****",
  "Items" : {
    "FailedItems" : [ {
      "ItemName" : "item1",
      "ItemId" : "c09f3d63-eacf-4fbf-bd48-a07a6ba7****"
    } ],
    "SuccessItems" : [ {
      "ItemName" : "item2",
      "ItemId" : "c09f3d63-eacf-4fbf-bd48-a07a6ba7****"
    } ]
  },
  "ProgramId" : "445409ec-7eaa-461d-8f29-4bec2eb9****"
}

错误码

访问错误中心查看更多错误码。