Adds an episode list to a production studio for carousel playback.

Usage note

The parameters CallbackUrl and DomainName are required in the request. You can call the DescribeCasterConfig to get the values.

QPS limit

A single user can perform a maximum of 4 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddCasterEpisodeGroup

The operation that you want to perform. Set the value to AddCasterEpisodeGroup.

CallbackUrl String Yes****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

The callback URL.

You can call the DescribeCasterConfig operation to get the CallbackUrl.

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

The client token that is used to ensure the idempotence of the request.

You can use the client to generate a token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

DomainName String Yes

The main streaming domain.

RepeatNum Integer Yes 0

The number of times the episode list repeats after the first playback is complete. Valid values:

  • 0: indicates that the episode list is played only once.
  • -1: indicates that the episode list is played in loop mode.
SideOutputUrl String Yes http://****/****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

The custom standby URL.

If this parameter is empty, the ingest address corresponding to the output address automatically generated by Alibaba Cloud will be used by default.

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

The time when the episode list starts to play. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

RegionId String No cn-shanghai

The ID of the region.

Item.N.ItemName String No Episode 1

The name of episode N.

Item.N.VodUrl String No http://****/****.flv?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

The URL of the VOD file.

If you query the production studio video source through the DeleteCasterVideoResource, please check the parameter VodUrl value returned by the DescribeCasterVideoResources interface call.

This parameter takes effect only when the video resource is a video file that is not from the media library.

The video file must be in the MP4, FLV, or TS format.

Response parameters

Parameter Type Example Description
ItemIds List [ "21926b36-7dd2-4fde-ae25-51b5bc8e****", "21926b36-7dd2-4fde-ae25-51b5bc98****" ]

The IDs of episodes in the list.

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

The ID of the episode list that was added. Record the ID as it can be used to manage the program being added.

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

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "ProgramId": "16A96B9A-F203-4EC5-8E43-CB92E68X****",
    "ItemIds": [

Error codes

For a list of error codes, visit the API Error Center.