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

Usage note

You can include the details about the program (episode list) in one parameter Content by calling this operation.

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.

Debugging

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 AddCasterEpisodeGroupContent

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

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.

Content String Yes {"CallbackUrl":"http://example.aliyundoc.com/callBackLive","SideOutputUrl":"rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****","DomainName":"developer.aliyundoc.com ","StartTime":"2018-03-26T16:00:00Z","RepeatNum":-1,"Items":[{"ItemName":"Episode1","VodUrl":"http://learn.aliyundoc.com"},{"ItemName":"Episode2","VodUrl":"http://demo.aliyundoc.com"}]}

The information about the episode list. The value is a JSON string. Use upper camel case for fields of the string. This parameter contains the following fields:

  • CallbackUrl: the callback URL.
  • SideOutputUrl: the custom standby URL.
  • RepeatNum: the number of times the episode list repeats after the first playback is complete. A value of 0 indicates that the episode list is played only once. A value of -1 indicates that the episode list is played in loop mode.
  • DomainName: the domain name.
  • StartTime: 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.
  • Items: the information about the episode list. It is an array of ItemName and VodUrl.
    • ItemName: the name of the episode.
    • VodUrl: the URL of the VOD file. This field 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.
RegionId String No cn-shanghai

The ID of the region.

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.
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=AddCasterEpisodeGroupContent
&ClientToken=8751ad99-2ddb-4aac-ad44-84b21102****
&Content={"CallbackUrl":"http://example.aliyundoc.com/callBackLive","SideOutputUrl":"rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****","DomainName":"developer.aliyundoc.com ","StartTime":"2018-03-26T16:00:00Z","RepeatNum":-1,"Items":[{"ItemName":"Episode1","VodUrl":"http://learn.aliyundoc.com"},{"ItemName":"Episode2","VodUrl":"http://demo.aliyundoc.com"}]}
&<Common request parameters>

Sample success responses

XML format 

<AddCasterEpisodeGroupContentResponse>
      <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>
</AddCasterEpisodeGroupContentResponse>

JSON format 

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

Error codes

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