调用AddCasterEpisodeGroup添加导播台节目列表。

使用说明

先创建导播台和获取导播台配置信息,再调用本接口添加导播台节目列表。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String AddCasterEpisodeGroup

系统规定参数,取值:AddCasterEpisodeGroup

CallbackUrl String http://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

用户回调地址。

如果您通过DescribeCasterConfig接口查询导播台配置信息,请查看DescribeCasterConfig接口调用返回的参数CallbackUrl值。

ClientToken String 8751ad99-2ddb-4aac-ad44-84b21102****

用户生成的请求token。用于保证请求的幂等性。

注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。
DomainName String example.com

主播流域名。

RepeatNum Integer 0

重复次数。取值:

  • 0:不循环。
  • -1:无限循环。
SideOutputUrl String rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

用户自定义导播台旁路输出地址对应的推流地址。

若该参数为空,则默认使用阿里云自动生成的输出地址对应的推流地址。

StartTime String 2018-03-06T19:00:00Z

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

RegionId String cn-shanghai

地域ID。

Item.N.ItemName String 节目1

节目名称。

Item.N.VodUrl String http://learn.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****.flv?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

点播文件地址。

如果您通过DescribeCasterVideoResources接口查询导播台视频源,请查看DescribeCasterVideoResources接口调用返回的参数VodUrl值。

说明

当且仅当资源为文件视频,且视频文件未导入素材库时使用。

支持MP4、FLV、TS格式。

返回数据

名称 类型 示例值 描述
ItemIds List [ "21926b36-7dd2-4fde-ae25-51b5bc8e****", "21926b36-7dd2-4fde-ae25-51b5bc98****" ]

节目ID列表。

ProgramId String 16A96B9A-F203-4EC5-8E43-CB92E68X****

节目单ID。可作为删除导播台节目列表,创建或添加节目单项,删除节目单项,查询节目单项,编辑节目单,删除节目单,查询节目单,启动节目单,停止节目单的请求参数。

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddCasterEpisodeGroup
&CallbackUrl=http://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
&ClientToken=8751ad99-2ddb-4aac-ad44-84b21102****
&DomainName=example.com
&RepeatNum=0
&SideOutputUrl=rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
&StartTime=2018-03-06T19:00:00Z
&<公共请求参数>

正常返回示例

XML格式

<AddCasterEpisodeGroupResponse>
	  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
	  <ProgramId>16A96B9A-F203-4EC5-8E43-CB92E68X****</ProgramId>
	  <ItemIds>21926b36-7dd2-4fde-ae25-51b5bc8e****</ItemIds>
	  <ItemIds>21926b36-7dd2-4fde-ae25-51b5bc98****</ItemIds>
</AddCasterEpisodeGroupResponse>

JSON格式

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "ProgramId": "16A96B9A-F203-4EC5-8E43-CB92E68X****",
    "ItemIds": [
      "21926b36-7dd2-4fde-ae25-51b5bc8e****",
      "21926b36-7dd2-4fde-ae25-51b5bc98****"
    ]
}

错误码

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