# Alibaba Cloud ApsaraVideo Live API

> Alibaba Cloud ApsaraVideo Live API on Apizie: 400 endpoints (Adds a component to a production studio, Adds an episode to a production studio, Adds a program list to a production studio, Adds content to an episode group of a production studio, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-live/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-live`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/live
- Page: https://zieapi.vercel.app/api/cloud/aliyun-live
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-live/openapi.json

Alibaba Cloud OpenAPI for ApsaraVideo Live (live, version 2016-11-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a component to a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-component` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region |
| CasterId | string | yes | The ID of the production studio. If you create the production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| ComponentName | string | no | The name of the component. The default value is the component ID |
| LocationId | string | yes | Specifies the position of the component. Each position can hold only one component. The format must be RC01 to RC99. If the component type… |
| ComponentType | string | yes | The type of component. Valid values: text: A text component. If you set this parameter to text, you must also set the TextLayerContent… |
| Effect | string | no | The display effect of the component. Valid values: none (default): No effect. animateH: Scrolls horizontally. animateV: Scrolls vertically |
| ComponentLayer | string | yes | The size, layout, and other information about the component layer. The elements are described as follows: HeightNormalized: The normalized… |
| LayerOrder | string | no | The layer order of the component. cover: The component is in the foreground. background: The component is in the background |
| TextLayerContent | string | no | The properties of the layer element. The properties are described as follows: This parameter is required only when ComponentType is set to… |
| ImageLayerContent | string | no | The properties of the layer element. The properties are described as follows: This parameter is required when ComponentType is set to… |
| CaptionLayerContent | string | no | The properties of the layer element. The properties are described as follows: This parameter is required when ComponentType is set to… |
| HtmlLayerContent | string | no | The configuration of the H5 component |

### Adds an episode to a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-episode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ComponentId | string | no | A list of component IDs. The components are layered from bottom to top in the specified order. If you add a component by calling the… |
| CasterId | string | yes | The ID of the production studio. If you create a production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| EpisodeType | string | yes | The node type. Valid values: Resource: A video source. If you set this parameter to Resource, you must also specify the ResourceId and… |
| EpisodeName | string | no | The name of the episode |
| ResourceId | string | no | The ID of the video source. This parameter is required and applies only when EpisodeType is set to Resource. If you add a video source by… |
| StartTime | string | yes | The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC |
| EndTime | string | yes | The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC |
| SwitchType | string | yes | The switch policy. Valid values: This parameter applies only when EpisodeType is set to Resource. TimeFirst: Time first. ContentFirst:… |

### Adds a program list to a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-episode-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Item | string | yes | The program list (JSON-encoded) |
| ClientToken | string | yes | The request token generated by the user. This parameter is used to ensure the idempotence of the request. This parameter value is… |
| DomainName | string | yes | The primary streaming domain |
| StartTime | string | yes | The start time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC) |
| RepeatNum | integer | yes | The number of repetitions. Valid values: 0: no loop. -1: infinite loop |
| SideOutputUrl | string | yes | The ingest URL corresponding to the custom bypass output address of the production studio |
| CallbackUrl | string | yes | The callback URL. The URL must be a valid URL that complies with RFC 2396. The host must be a real domain name or IP address that can be… |

### Adds content to an episode group of a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-episode-group-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ClientToken | string | yes | A client-generated token that is used to ensure the idempotence of the request. The client generates this value. Make sure that the value… |
| Content | string | yes | The properties of the episode in the production studio. This parameter is a JSON string. The parameter names are in upper camel case. The… |

### Adds a layout to a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| VideoLayer | string | yes | The video layouts (JSON-encoded) |
| AudioLayer | string | yes | The audio layouts (JSON-encoded) |
| BlendList | string | yes | The location IDs of the video sources. The order of the location IDs corresponds to the order of the video layers specified in the… |
| MixList | string | yes | The location IDs of the audio sources. The order of the location IDs corresponds to the order of the audio layers specified in the… |
| CasterId | string | yes | The ID of the production studio. If you create a production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |

### Adds a program list to a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-program` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Episode | string | yes | The program list information (JSON-encoded) |
| CasterId | string | yes | The production studio ID. If you created the production studio by calling the https://help.aliyun.com/document_detail/2848009.html, check… |

### Adds a video source to a production studio. The number of video sources is limited by the number of input…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-video-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The production studio ID. If you created the production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| ResourceName | string | yes | The name of the video source |
| LocationId | string | no | The location identifier of the video source. This parameter is required. Defines the reference number of a scene in the layout. Each… |
| LiveStreamUrl | string | no | The ApsaraVideo Live streaming URL. This parameter is required when the video source type is live stream. Do not include this parameter in… |
| MaterialId | string | no | The media asset library material ID. This parameter is available and required only when the video source type is material. If you call the… |
| VodUrl | string | no | The video-on-demand file URL. This parameter is available only when the video source type is file video and the video file has not been… |
| BeginOffset | integer | no | The start offset of the video file. Unit: milliseconds. This parameter takes effect only when the video source type is file video. A value… |
| EndOffset | integer | no | The end offset of the video file. Unit: milliseconds. This parameter takes effect only when the video source type is file video. A value… |
| RepeatNum | integer | no | The number of times the video repeats after playback completes. Valid values: This parameter takes effect only when the video source type… |
| PtsCallbackInterval | integer | no | The PTS callback interval. Unit: milliseconds |
| FixedDelayDuration | integer | no | The fixed delay for the video, which can be used for subtitle synchronization. Unit: ms. Default value: 0. Value range: `[0-5000]` |
| ImageId | string | no | The media asset library image material ID. This parameter is available and required only when the video source type is image |
| ImageUrl | string | no | The image material URL. This parameter is available only when the video source type is image and the image file has not been imported to… |

### Adds a custom transcoding configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-custom-live-stream-transcode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Domain | string | yes | The streaming domain |
| App | string | yes | The AppName of the live stream |
| KmsKeyID | string | no | The ID of the customer master key (CMK) in Key Management Service (KMS) |
| KmsUID | string | no | The ID of the KMS account |
| KmsKeyExpireInterval | string | no | The key rotation period. Unit: seconds. Valid values: 60 to 3600 |
| Template | string | yes | The custom name of the transcoding template. The name can contain digits, letters, and hyphens (-). It must start with a digit or a… |
| TemplateType | string | yes | The type of the custom transcoding template. Valid values: h264: custom H.264 standard transcoding. h264-nbhd: custom H.264 Narrowband HD™… |
| Height | integer | no | Output video height in pixels. Requirements: Height ≥ 100 max(Height, Width) ≤ 2560 min(Height, Width) ≤ 1440 For h265-nbhd, it cannot… |
| Width | integer | no | Output video width in pixels. Requirements: Width ≥ 100 max(Height, Width) ≤ 2560 min(Height, Width) ≤ 1440 For h265-nbhd, it cannot… |
| FPS | integer | no | The frame rate of the output video. Unit: frames per second (FPS). Valid values: 1 to 60 |
| VideoBitrate | integer | no | The output video bitrate. Unit: kbps. Valid values: 1 to 6000. The system tries to transcode the video at the specified bitrate. However,… |
| AudioBitrate | integer | no | The output audio bitrate. Unit: kbps. Valid values: 1 to 1000 |
| Gop | string | no | The Group of Pictures (GOP) size. The unit can be frame or second. Valid values: By frames: 1 to 3000. By seconds: 1s to 20s |
| Profile | integer | no | The video codec profile. A larger value indicates better video quality and higher resource consumption for encoding and decoding. Valid… |
| AudioProfile | string | no | The audio profile. Valid values: aac_low aac_he aac_he_v2 aac_ld |
| AudioCodec | string | no | The audio codec. Valid values: AAC MP3 |
| AudioRate | integer | no | The audio sample rate. Valid values: 22050 to 96000. If you set AudioProfile to aac_ld, the sample rate cannot exceed 44100. |
| AudioChannelNum | integer | no | The number of audio channels. Valid values: 1: mono. 2: stereo |
| Lazy | string | no | Specifies whether to enable on-demand transcoding. Valid values: yes: Transcoding only starts when the first viewer requests this… |
| EncryptParameters | string | no | The encryption settings, formatted as a JSON string. EncryptType: The encryption type. Set the value to aliyun. KmsKeyID: The ID of the… |
| ResWithSource | string | no | The adaptive resolution settings. If specified, it overrides the Height and Width parameters. Fieds: Type (string): Required. Valid… |
| FpsWithSource | string | no | Adapts the output frame rate based on the source's frame rate, while keeping it within a specified range. If specified, it overrides the… |
| BitrateWithSource | string | no | The adaptive bitrate settings. If specified, it overrides the VideoBitrate parameter. Fields: UpLimit (integer): Required. The upper limit… |
| ExtWithSource | string | no | Other adaptive settings that align the transcoded stream with the source stream. Fields: KeyFrameOpen: Specifies whether to align… |
| DeInterlaced | string | no | Specifies whether to automatically detect and remove interlacing during transcoding. Deinterlacing converts interlaced video into… |

### Adds a subtitle rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-aiproduce-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Domain | string | yes | The streaming domain |
| App | string | yes | The name of the live streaming application. The name can be up to 256 characters long and can contain digits, uppercase and lowercase… |
| Suffix | string | no | The suffix to match |
| SubtitleName | string | no | The name of the subtitle template |
| StudioName | string | no | The name of the virtual background template |
| IsLazy | string | no | Specifies whether the rule is triggered by stream pulling. Valid values: true: Subtitles are generated when stream pulling starts. If no… |
| LiveTemplate | string | yes | The specifications of the output subtitles. Valid values: Landscape low definition 360p (640 × 360): `lp_ld` Portrait low definition 360p… |
| Description | string | no | The description of the subtitle rule. The description can contain Chinese and English characters, digits, and special characters. It can… |

### Adds a subtitle template by calling AddLiveAISubtitle
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-aisubtitle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| SubtitleName | string | yes | The name of the subtitle template. The name can contain only digits, letters, and hyphens (-). The name cannot start with a hyphen |
| SrcLanguage | string | yes | The source language. Valid values: English: en-US Chinese: zh-CN Russian: ru-RU |
| DstLanguage | string | no | The target language for translation. Valid values: English: en-US Chinese: zh-CN Spanish: es-ES Russian: ru-RU |
| FontColor | string | no | The font color. Specify the value in RGBA format |
| FontName | string | no | The font. Valid values: KaiTi: KaiTi (default) AlibabaPuHuiTi-Regular: Alibaba PuHuiTi Regular AlibabaPuHuiTi-Bold: Alibaba PuHuiTi Bold… |
| BgColor | string | no | The background color of the subtitle. Specify the value in RGBA format |
| PositionNormalized | string | yes | The position of the subtitle. The value is the x,y coordinates with the bottom-left corner of the screen as the origin. The x and y values… |
| ShowSourceLan | string | no | Specifies whether to display the source language. Default value: false |
| MaxLines | integer | no | The number of lines to display |
| WordPerLine | integer | yes | The number of characters per line. Valid values: integers in the range of [1, 500] |
| FontSizeNormalized | number | yes | The font size. Valid values: [0, 1] |
| BorderWidthNormalized | number | no | The font weight. Valid values: [0, 1] |
| BgWidthNormalized | number | no | The background size of the subtitle. Valid values: [0, 1] |
| CopyFrom | string | no | The subtitle template to copy from. Set this parameter to the value of SubtitleName |
| Description | string | no | The custom description of the subtitle. The description can contain Chinese characters, letters, digits, and special characters, and… |
| Width | string | no | The width of the preview screen. Unit: px |
| Height | string | no | The height of the preview screen. Unit: px. The width × height of the preview screen supports only the following specifications: Landscape… |

### Configures recording for an application and saves the output to Object Storage Service (OSS)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-app-record-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The streaming domain of the streamer |
| AppName | string | yes | The name of the application to which the stream belongs. The template takes effect only when the AppName value matches the AppName in the… |
| OssEndpoint | string | yes | The endpoint of the OSS bucket. To store live recordings in OSS, create an OSS bucket in advance. For more information, see… |
| OssBucket | string | yes | The name of the OSS bucket. To store live recordings in OSS, create an OSS bucket in advance. For more information, see… |
| StreamName | string | no | The stream name. The template takes effect only when the StreamName value matches the StreamName in the ingest URL. To match all stream… |
| StartTime | string | no | The recording start time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC). The specified time must be within 7 days of the actual stream ingest… |
| EndTime | string | no | The recording end time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC). The difference between EndTime and StartTime cannot exceed 7 days. If it… |
| OnDemand | integer | no | The on-demand or manual recording mode. Valid values: 0 (default): disabled. Automatic recording is used. 1: on-demand recording through… |
| DelayTime | integer | no | The stream discontinuity merging duration. If the live stream is disconnected for longer than the specified merging duration, a new file… |
| RecordFormat | string | no | The recording details (JSON-encoded) |
| TranscodeRecordFormat | string | no | The transcoded stream recording details (JSON-encoded) |
| TranscodeTemplates | string | no | The transcoding template group for transcoded stream recording (JSON-encoded) |

### Configures the snapshot feature for a streaming domain. The captured snapshots are stored in Object Storage…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-app-snapshot-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The name of the application to which the live stream belongs. The value of this parameter must be the same as the application name in the… |
| TimeInterval | integer | yes | The interval at which snapshots are captured. Unit: seconds. Valid values: 5 to 3600 |
| OssEndpoint | string | yes | The endpoint of the OSS bucket. After the configuration is complete, you can search for specific snapshots in the OSS console based on the… |
| OssBucket | string | yes | The name of the OSS bucket. After the configuration is complete, you can search for specific snapshots in the OSS console based on the… |
| OverwriteOssObject | string | no | The naming format of snapshots that are stored in the overwrite mode, which means that a new snapshot overwrites the previous snapshot.… |
| SequenceOssObject | string | no | The naming format of snapshots that are stored in sequence, which means that a new snapshot does not overwrite the previous snapshot. You… |
| Callback | string | no | The callback URL that is used to receive notifications about snapshot capture |

### Adds an audio moderation configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-audio-audit-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The AppName of the live stream. The AppName must match that in the ingest URL for the template to take effect. The value is case-sensitive |
| StreamName | string | yes | The name of the live stream. The StreamName must match that in the ingest URL for the template to take effect. The value is case-sensitive |
| OssBucket | string | no | The name of the OSS bucket |
| OssEndpoint | string | no | The endpoint of the OSS bucket |
| OssObject | string | no | The name of the recording file stored in OSS |
| BizType | string | no | The business type. This parameter can be used to select a model. The default value is the domain name |

### Adds a callback configuration for audio moderation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-audio-audit-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |
| Callback | string | no | The URL used to receive callbacks for audio that contains problematic content |
| CallbackTemplate | string | no | The callback template for automated reviews. The value is a JSON string that can contain the following variables: {DomainName}: The… |

### Adds a live center stream relay configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-center-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The name of the live stream application. The AppName you enter must be the same as the AppName of the live stream to be relayed for the… |
| StreamName | string | yes | The name of the live stream. You can view the StreamName on the https://help.aliyun.com/document_detail/197397.html page |
| DstUrl | string | yes | The third-party live streaming address for relay. You can add up to one address. The protocol of the destination address must be the same… |
| TransferArgs | string | yes | The validity period of the relay. Valid values: always: permanently effective. time: effective within the specified time period. If the… |
| StartTime | string | no | The start time of the relay. The date format follows the ISO 8601 notation and uses UTC+0 time. The format is yyyy-MM-ddTHH:mm:ssZ |
| EndTime | string | no | The end time of the relay. The date format follows the ISO 8601 notation and uses UTC+0 time. The format is yyyy-MM-ddTHH:mm:ssZ. The end… |

### Configures callbacks for video moderation results. As a result, a callback URL that is used to receive the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-detect-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |
| NotifyUrl | string | yes | The callback URL that is used to receive callback notifications about violations, such as pornographic content and politically sensitive… |

### Adds a live streaming domain name. You can add only one domain name at a time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| LiveDomainType | string | yes | The type of the domain name. Valid values: liveVideo: streaming domain. If you set DomainName (the domain name to be connected to… |
| DomainName | string | yes | The ingest domain or streaming domain to be connected to ApsaraVideo Live. Wildcard domain names are supported and must start with a… |
| Region | string | yes | The unit information of the live streaming domain name. Valid values: cn-beijing: Beijing. cn-shanghai: Shanghai. cn-shenzhen: Shenzhen.… |
| CheckUrl | string | no | The health check URL |
| Scope | string | no | The acceleration region. This parameter takes effect for international users and China site users at L3 or above. Valid values: domestic… |
| TopLevelDomain | string | no | The top-level domain name for access |
| ResourceGroupId | string | no | The resource group ID. For more information about resource groups, see https://help.aliyun.com/document_detail/2381067.html |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates the mapping between a streaming domain and an ingest domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-domain-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PushDomain | string | yes | The ingest domain. The type of the domain name is liveEdge |
| PullDomain | string | yes | The streaming domain. The type of the domain name is liveVideo |

### Maps a sub-streaming domain to a main streaming domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-domain-play-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| PlayDomain | string | yes | The sub-streaming domain |
| PullDomain | string | yes | The main streaming domain |

### The AddLiveMessageGroupBand operation mutes users in a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-message-group-band` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| GroupId | string | yes | The group ID |
| BannedUsers | string | yes | A list of users to mute. Separate multiple user IDs with a comma (,). You can specify a maximum of 30 users (JSON-encoded) |
| DataCenter | string | no | The data center. This must be the same data center that you specified when you called the… |

### You can call the AddLivePackageConfig operation to add a live stream packaging configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-package-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The live streaming domain name. This is the primary playback domain name |
| AppName | string | yes | The AppName must match the AppName in the ingest URL for the template to take effect. The AppName can be up to 255 characters in length… |
| StreamName | string | yes | The StreamName must match the StreamName in the ingest URL for the template to take effect. The StreamName can be up to 255 characters in… |
| Protocol | string | yes | The live streaming protocol and container format. Valid values: HLS_CMAF LLHLS_TS (low latency) LLHLS_CMAF (low latency) DASH_CMAF… |
| SegmentNum | integer | no | The number of M3U8 segments for live streaming. Valid values: 3 to 10. Default value: 3 |
| SegmentDuration | integer | no | The segment length, in seconds. If you set Protocol to HLS_CMAF, the valid values are 1 to 10. The default value is 5. If you set Protocol… |
| PartDuration | integer | no | The length of the part segment, in milliseconds. If SegmentDuration is 1 s, the valid values are 100 to 500. The default value is 350. If… |
| IgnoreTranscode | string | no | Specifies whether to ignore transcoded streams. Valid values: true (default): Ignore transcoded streams. false: Do not ignore transcoded… |

### Creates a scheduled stream pulling configuration, which includes parameters such as the origin URL, start…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-pull-stream-info-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain where the ingested stream will be hosted and distributed from |
| AppName | string | yes | The custom name of the application |
| StreamName | string | yes | The custom name of the live stream |
| SourceUrl | string | yes | The origin URL of the live stream. You can specify multiple URLs. Separate them with semicolons (;). You can pull only live streams in the… |
| StartTime | string | yes | The time when stream pulling starts. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC |
| EndTime | string | yes | The time when stream pulling ends. The time range specified by the StartTime and EndTime parameters cannot exceed seven days. The time… |

### Adds a domain-level recording callback configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-record-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The streamer streaming domain |
| NotifyUrl | string | yes | The callback URL for recording events and status callbacks. The URL must start with `http://` or `https://`. For more information, see… |
| NeedStatusNotify | string | no | Specifies whether recording task status callbacks are required. Valid values: true: Required. If NeedStatusNotify is set to true, the… |
| OnDemandUrl | string | no | The callback URL for on-demand recording. The URL must start with `http://` or `https://`. For more information, see… |
| NotifyReqAuth | string | no | Specifies whether to enable callback authentication. Valid values: true: Enabled. false (default): Disabled. When this parameter is set to… |
| NotifyAuthKey | string | no | The callback authentication key. The key must be 16 to 32 characters in length and can contain only letters and digits. This parameter is… |

### Creates a live-to-VOD configuration to store recordings in ApsaraVideo VOD
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-record-vod-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. The example value `cn-shanghai` indicates the China (Shanghai) region |
| DomainName | string | yes | The streaming domain. Ensure ApsaraVideo VOD is activated in the same region as the streaming domain |
| AppName | string | yes | The name of the application that the stream belongs to. You can find this value on the https://help.aliyun.com/document_detail/197397.html… |
| StreamName | string | no | The stream name. You can find this value on the https://help.aliyun.com/document_detail/197397.html page |
| VodTranscodeGroupId | string | no | This parameter is ignored if `RecordFormat` is specified.> The ID of the ApsaraVideo VOD transcoding template group for transcoding… |
| CycleDuration | integer | no | The cycle duration, in seconds. The default value is 3600. The value must be between 300 and 21600 |
| AutoCompose | string | no | This parameter is ignored if `RecordFormat` is specified.> Specifies whether to automatically merge files from multiple recording cycles… |
| SpaceId | string | no | The ID of the VOD application space. You can obtain this ID from the VOD console or by calling an… |
| StorageLocation | string | no | The storage location |
| ComposeVodTranscodeGroupId | string | no | This parameter is ignored if `RecordFormat` is specified.> The ID of the ApsaraVideo VOD transcoding template group for transcoding the… |
| OnDemand | integer | no | The recording trigger mode. Valid values: 0 (Default): Automatic recording. 1: On-demand recording triggered by an HTTP callback. 2:… |
| RecordContent | string | no | The recorded content. Valid values: `raw` (Default): Records the source stream. `transcode`: Records transcoded streams. To record both… |
| DelayTime | integer | no | The stream interruption timeout, in seconds. If a stream interruption is shorter than this duration, recording continues in the same file.… |
| RecordFormat | string | no | A list of format-specific recording configurations (JSON-encoded) |
| TranscodeTemplates | string | no | A list of transcoding templates for recording transcoded streams (JSON-encoded) |

### Adds a video moderation configuration for live streams in an application under a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-snapshot-detect-porn-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The name of the application to which the live stream belongs |
| OssEndpoint | string | yes | The endpoint of the Object Storage Service (OSS) bucket. After the review is complete, you can search for specific violations in the OSS… |
| OssBucket | string | yes | The name of the OSS bucket. After the review is complete, you can search for specific violations in the OSS console based on the callback… |
| OssObject | string | no | The name of the snapshot that stores violations such as pornographic content and politically sensitive content |
| Interval | integer | no | The interval at which snapshots are captured from the live stream. Valid values: 5 to 3600. Unit: seconds |
| Scene | string | no | Scene list detection (JSON-encoded) |

### Configures snapshot callbacks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-snapshot-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |
| NotifyUrl | string | yes | The callback URL. The URL must be valid, with a maximum length of 500 characters |
| NotifyReqAuth | string | no | Specifies whether to enable callback authentication. Valid values: yes: Enables no (Default): Disables If you set this parameter to yes,… |
| NotifyAuthKey | string | no | The authentication key for the callback. The key must be 16 to 32 characters in length and contain only letters and digits. This parameter… |

### Adds a primary and backup stream merging configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-stream-merge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The application name for the merged stream output. The application name must match the application name in the ingest URL for the template… |
| StreamName | string | yes | The stream name for the merged stream output. The stream name must match the stream name in the ingest URL for the template to take… |
| InAppName1 | string | yes | The application name of the primary input stream for merging. The specified application name must match the application name in the ingest… |
| InStreamName1 | string | yes | The stream name of the primary input stream for merging. The specified stream name must match the stream name in the ingest URL of the… |
| InAppName2 | string | yes | The application name of the backup input stream for merging. The specified application name must match the application name in the ingest… |
| InStreamName2 | string | yes | The stream name of the backup input stream for merging. The specified stream name must match the stream name in the ingest URL of the… |
| StartTime | string | yes | The start time of stream merging. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC |
| EndTime | string | yes | The end time of stream merging. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The… |
| Protocol | string | no | The live stream protocol. Valid values: rtmp (default) rtc |
| LiveMerger | string | no | Specifies whether to use the liveswitch engine. Valid values: on: Uses the new liveswitch engine. off: Uses the legacy engine such as… |
| MergeParameters | string | no | The configuration parameters for stream switching. Triggers a primary-backup switchover immediately when a stream interruption (EOF or… |
| SelectAppName | string | no | The SelectAppName |
| SelectStreamName | string | no | The SelectStreamName |
| SwitchMode | string | no | The switching mode for primary and backup stream merging. Valid values: manually and automatically |

### Calls AddLiveStreamTranscode to add transcoding configuration information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-stream-transcode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. When using SDK 2.0, set this parameter to the region ID that corresponds to the service registration endpoint. When using… |
| Domain | string | yes | The streaming domain of the streamer |
| App | string | yes | The name of the application to which the stream belongs. The value of App must be the same as the AppName in the ingest URL for the… |
| Template | string | yes | The transcoding template. Valid values: Standard quality templates: - lld: low definition. - lsd: standard definition. - lhd: high… |
| EncryptParameters | string | no | The encryption configuration. JSON format. The fields are described as follows: EncryptType: the encryption type. Set the value to aliyun.… |
| Lazy | string | no | Specifies whether to enable on-demand transcoding. Valid values: yes: enables on-demand transcoding. no: disables on-demand transcoding |

### Adds a watermark template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-stream-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Type | integer | yes | The type of the watermark. Valid value: 0: image |
| Name | string | yes | The name of the watermark template |
| RefWidth | integer | yes | The reference width of the video background, in pixels |
| RefHeight | integer | yes | The reference height of the video background, in pixels |
| XOffset | number | yes | The X-axis offset of the watermark, in pixels. Relative to RefWidth. If OffsetCorner is TopLeft, XOffset is the horizontal distance… |
| YOffset | number | yes | The Y-axis offset of the watermark, in pixels. Relative to RefHeight. If OffsetCorner is TopLeft, YOffset is the vertical distance between… |
| Height | integer | yes | The height of the watermark image, in pixels. This value is relative to `RefHeight` and will be scaled proportionally with the actual… |
| Transparency | integer | yes | The opacity of the watermark. Value range: `0` (fully transparent) to `255` (fully opaque) |
| OffsetCorner | string | yes | The anchor point for the watermark's position. Valid values: TopLeft TopRight BottomLeft BottomRight |
| PictureUrl | string | yes | The URL of the watermark image |
| Description | string | no | A custom description for the watermark |
| Domain | string | no | The streaming domain |

### Adds a watermark rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-live-stream-watermark-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Name | string | yes | The name of the custom rule |
| Domain | string | yes | The streaming domain |
| App | string | yes | The AppName of the live stream |
| Stream | string | yes | The stream name. The following rules apply: To match a specific stream, enter the full stream name. For example, liveStreamA. You can use… |
| TemplateId | string | yes | The ID of the watermark template. Get the template ID from the response of the https://help.aliyun.com/document_detail/2848096.html… |
| Description | string | no | The description of the custom rule |

### Adds a playlist item
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-playlist-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The production studio ID. If you created the production studio by calling the https://help.aliyun.com/document_detail/2848009.html, check… |
| ProgramItems | string | yes | The list of playlist item inputs. The value is a JSON string. For more information, see InputProgramItem |
| ProgramId | string | no | The playlist ID. If the production studio already has a playlist, you must specify the corresponding ProgramId. If no playlist has been… |
| ProgramConfig | string | no | The playlist item configuration. If this is the first time you add a playlist item, specify this parameter for initialization. For more… |

### Adds a custom transcoding configuration for a streaming domain with Real-Time Streaming (RTS) enabled
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-rts-live-stream-transcode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Domain | string | yes | The streaming domain |
| App | string | yes | The AppName of the live stream. Requirements: Supports letters, digits, underscores (_), and hyphens (-). Must start with a letter or a… |
| Template | string | yes | The name of the custom transcoding template. Requirements: Supports letters, digits, underscores (_), and hyphens (-). Must start with a… |
| TemplateType | string | yes | The type of the custom transcoding template. Valid values: h264: custom H.264 standard transcoding. h264-nbhd: custom H.264 Narrowband HD™… |
| Height | integer | no | Output video height in pixels. Required if you set TemplateType to h264, h264-nbhd, or h264-origin. Requirements: Height ≥ 100 max(Height,… |
| Width | integer | no | Output video width in pixels. Required if you set TemplateType to h264, h264-nbhd, or h264-origin. Requirements: Width ≥ 100 max(Height,… |
| FPS | integer | no | The frame rate of the output video. Unit: frames per second (FPS). Valid values: 1 to 60. Required if you set TemplateType to h264,… |
| VideoBitrate | integer | no | The output video bitrate. Unit: kbps. Valid values: 1 to 6000. Required if you set TemplateType to h264, h264-nbhd, or h264-origin. The… |
| AudioBitrate | integer | no | The output audio bitrate. Unit: kbps. Valid values: 1 to 1000. Required if you set TemplateType to audio. |
| Gop | string | no | The Group of Pictures (GOP) size, which specifies the keyframe interval. Unit: seconds. Valid values: 1 to 3 |
| DeleteBframes | string | no | Controls whether to remove B-frames from the transcoded output video. Valid values: Required if you set TemplateType to h264, h264-nbhd,… |
| Opus | string | no | Specifies whether to use the Opus codec for audio transcoding. This is mainly for compatibility with native WebRTC. Valid values: true:… |
| Profile | integer | no | The video codec profile. A larger value indicates better video quality and higher resource consumption for encoding and decoding. Valid… |
| AudioProfile | string | no | The audio codec profile. Valid values: aac_low aac_he aac_he_v2 aac_ld |
| AudioCodec | string | no | The audio codec. Valid values: aac mp3 To use the Opus codec, set the Opus parameter to true |
| AudioRate | integer | no | The audio sample rate. Valid values: 22050 to 96000. Recommended: 44100. Unit: Hz. If AudioProfile is set to aac_ld, the sample rate… |
| AudioChannelNum | integer | no | The number of audio channels. Valid values: 1: mono. 2: stereo |
| Lazy | string | no | Specifies whether to enable on-demand transcoding. Valid values: yes: Transcoding only starts when the first viewer requests this… |

### Adds a show to a playlist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-show-into-show-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| showList | string | no | The list of show resources to add. Each resource has independent parameters such as showName and resourceUrl (JSON-encoded) |
| CasterId | string | yes | The production studio ID. If you created the production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| ShowName | string | no | The show name |
| ResourceType | string | no | The resource type. Valid values: live: live streaming resource. vod: video-on-demand resource. pic: image resource. When using… |
| ResourceUrl | string | no | The URL of the playback file |
| ResourceId | string | no | The VOD file ID |
| Duration | integer | no | The playback duration of a single show. Unit: seconds. You can set only one of RepeatTimes and Duration. This parameter is required when… |
| RepeatTimes | integer | no | The number of times a single show is repeated. Default value: 0. You can set only one of RepeatTimes and Duration.- RepeatTimes specifies… |
| Spot | integer | no | The position in the playlist where the show is inserted. Positions start from 0. By default, the show is added to the end of the current… |
| LiveInputType | integer | no | The custom type tag |
| isBatchMode | string | no | Specifies whether to add shows to the playlist in batch. Valid values: true: Batch addition. false: Single addition. If this parameter is… |

### Adds layout settings for a virtual production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-studio-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The ID of the production studio. Create a virtual production studio in advance. You can create a production studio in the console or by… |
| LayoutName | string | yes | The name of the studio layout |
| LayoutType | string | yes | The type of the studio layout. Valid values: common: A common layout. If you set LayoutType to common, you must also specify CommonConfig.… |
| CommonConfig | string | no | The configuration of the common layout. The value is a JSON string. For more information, see CommonConfig. This parameter is required… |
| BgImageConfig | string | no | The configuration of the background resource. The value is a JSON string. For more information, see BgImageConfig. This parameter is… |
| ScreenInputConfigList | string | no | The settings for the chroma keying input. The value is a JSON string. For more information, see ScreenInputConfig. This parameter is… |
| MediaInputConfigList | string | no | The settings for the multimedia input resource. The value is a JSON string. For more information, see MediaInputConfig. This parameter is… |
| LayerOrderConfigList | string | no | The layer order settings. The value is a JSON string. For more information, see LayerOrderConfig. You can sort background materials and… |

### Inserts Supplemental Enhancement Information (SEI) data into transcoded streams
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-trancode-sei` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The AppName of the live stream. View AppNames on the https://help.aliyun.com/document_detail/197397.html page |
| StreamName | string | yes | The name of the live stream. It must be the name of the source stream. This ensures that SEI is inserted into all transcoded streams |
| Text | string | yes | The SEI text. Length limit: 4000 bytes |
| Pattern | string | yes | Specifies the insertion pattern for the SEI. keyframe: Inserts at every keyframe. frame: Inserts at every single frame |
| Repeat | integer | yes | The number of times to repeat the insertion. A value of -1 means infinite repetitions |
| Delay | integer | yes | The delay in milliseconds before the SEI is inserted after the command is received |

### Call the BanLiveMessageGroup operation to mute a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/ban-live-message-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| GroupId | string | yes | The group ID |
| ExceptUsers | string | no | The users who are exempt from the group-wide mute. Specify up to 30 users. Separate multiple user IDs with a comma (,) (JSON-encoded) |
| DataCenter | string | no | The data center. This value must be the same as the data center that you specified when you called… |

### Deletes the configurations of multiple domain names at a time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/batch-delete-live-domain-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainNames | string | yes | The ingest domain or streaming domain. Separate multiple domain names with commas (,) |
| FunctionNames | string | yes | The names of the features. Separate multiple features with commas (,). For more information, see Features specified by the Functions… |

### Queries whether one or more users are online based on their UIDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/batch-get-online-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the interactive messaging application |
| GroupId | string | yes | The message group ID |
| UserIds | string | yes | The list of user IDs. Separate multiple user IDs with commas (,). You can specify up to 20 user IDs |

### Configures domain names in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/batch-set-live-domain-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainNames | string | yes | The domain names that you want to configure in batches. The value can be an ingest domain, a primary streaming domain, or a secondary… |
| Functions | string | yes | The list of features. Some features, such as `filetype_based_ttl_set`, support multiple records. To update a specific record, specify the… |
| DryRun | string | no | Specifies whether to perform only a dry run without actually executing the operation. Valid values: true: Sends a dry run request. The… |

### Cancels the muting of a message group user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/cancel-mute-all-group-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | Interactive Messages application ID |
| GroupId | string | yes | Group ID |
| OperatorUserId | string | no | User ID of the operator. This parameter is required. The user must be the creator of the group |
| BroadCastType | integer | no | System message diffusion type. Valid values: 0: No diffusion. 1: Diffusion to specified users. 2: Diffusion to the group |

### Calls CancelMuteGroupUser to batch unmute members in a message group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/cancel-mute-group-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | Interactive Messages application ID |
| GroupId | string | yes | Message group ID |
| CancelMuteUserList | string | yes | User ID group (JSON-encoded) |
| OperatorUserId | string | no | Operator's user ID. This parameter must be filled and the user must be the creator of the group |
| BroadCastType | integer | no | System message diffusion type, values: 0 (default): No diffusion. 1: Diffusion to specified users. 2: Diffusion to the group |

### Moves a domain name in ApsaraVideo Live to a specified resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/change-live-domain-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region |
| DomainName | string | yes | The ingest or streaming domain name |
| NewResourceGroupId | string | yes | The ID of the destination resource group |

### Queries whether a user is in an interactive messaging group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/check-live-message-users-in-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| GroupId | string | yes | The group ID |
| UserIds | string | yes | The list of users that you want to query (JSON-encoded) |
| DataCenter | string | no | The data center. It must be the same as the data center that was specified when you called the… |

### Queries whether one or more specified users are online
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/check-live-message-users-online` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| UserIds | string | yes | The list of users that you want to query (JSON-encoded) |
| DataCenter | string | no | The data center. It must be the same as the data center that was specified when you called the… |

### Disables the time shifting service for a specified domain name (application or live stream)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/close-live-shift` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | no | The name of the application to which the live stream belongs. Wildcards (*) are supported, which indicates all AppName values under the… |
| StreamName | string | no | The name of the live stream. Wildcards (*) are supported, which indicates all StreamName values under the AppName. You can view the… |

### Duplicates a production studio and creates a new production studio instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/copy-caster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterName | string | yes | The name of the new production studio |
| SrcCasterId | string | yes | The ID of the production studio to copy. If you created the production studio by calling the… |
| ClientToken | string | yes | A client-generated token that ensures the idempotence of the request. Generate a unique value for this parameter for each request. The… |

### Applies the configuration of a PVW scene to a PGM scene
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/copy-caster-scene-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region |
| CasterId | string | yes | The ID of the production studio. If you create a production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| FromSceneId | string | yes | The ID of the source scene. The scene must be a PVW scene |
| ToSceneId | string | yes | The ID of the destination scene. The scene must be a PGM scene |

### Call the CreateCaster operation to create a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-caster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterName | string | no | The name of the production studio |
| ClientToken | string | yes | The client token that is used to ensure the idempotence of the request. Generate a token on your client and ensure that the token is… |
| NormType | integer | yes | The type of the production studio. Valid values: 1: Standard. 3: Lightweight Carousel. 4: Virtual Studio. 6: Carousel (New Playlist). 1:… |
| ChargeType | string | yes | The billing method. Only PostPaid is supported. Valid values: PrePaid: subscription (not supported). PostPaid: pay-as-you-go |
| PurchaseTime | string | no | The purchase time of the production studio. The time is in the \`yyyy-MM-ddTHH:mm:ssZ\` format and is displayed in UTC. This parameter is… |
| ExpireTime | string | no | The expiration time of the production studio. The time is in the \`yyyy-MM-ddTHH:mm:ssZ\` format and is displayed in UTC. This parameter… |
| CasterTemplate | string | no | The preset resolution of the production studio. This parameter is available only for the subscription billing method. Valid values: lp_ld:… |
| ResourceGroupId | string | no | The ID of the resource group. For more information, see https://help.aliyun.com/document_detail/2381067.html |
| Tag | string | no | The tags (JSON-encoded) |

### Creates a custom stream mixing template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-custom-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CustomTemplate | string | yes | The custom template in JSON format: {height:xxx,scale:xxx,gop:xxx,bframes:xxx,cdesc:xxx}. All fields are required. If any field is… |
| Template | string | yes | The name of the template to add. Record the template name when you create the template. The template name is required for using, querying,… |

### Creates an edge transcoding task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-edge-transcode-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ClusterId | string | yes | The data center ID. The specific value must be determined by convention after you submit a ticket or consult with the front-line team. For… |
| Name | string | yes | The task name. Supports Chinese and English characters, digits, hyphens, and underscores. The maximum length is 255 English characters |
| TemplateId | string | yes | The template ID |
| StreamInput | string | yes | The input stream URL |
| StreamOutput | string | yes | The output stream URL |

### Creates a callback for subscribing to channel messages
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-event-sub` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application to subscribe to. You can view your application IDs by navigating to ApsaraVideo Live > Live+ > ApsaraVideo… |
| ChannelId | string | no | The ID of the channel to subscribe to. You can call the https://help.aliyun.com/document_detail/2848210.html operation to query the… |
| Users | string | no | The users whose messages you want to subscribe to. If this parameter is empty, all users in the channel (including streamers and viewers)… |
| Events | string | yes | The subscription events (JSON-encoded) |
| CallbackUrl | string | yes | The callback URL. For the callback content, see the callback content examples below |

### Creates a lightweight virtual studio template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-aistudio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| StudioName | string | yes | The name of the virtual studio template. The name must be unique |
| Description | string | no | The custom description |
| Width | integer | no | The width of the preview screen. Unit: px |
| Height | integer | no | The height of the preview screen. Unit: px. The width × height of the preview screen supports only the following specifications: Landscape… |
| BackgroundType | string | no | The type of the background material. Valid values: VOD: video-on-demand video. PIC: image. LIVE: live stream |
| BackgroundResourceId | string | no | The video-on-demand resource ID of the background material. Obtain this value from the ApsaraVideo VOD console |
| BackgroundResourceUrl | string | no | The access URL of the background material. Specify either this parameter or the resource ID |
| MediaType | string | no | The type of the multimedia material. Valid values: VOD: video-on-demand video. PIC: image. LIVE: live stream |
| MediaResourceId | string | no | The video-on-demand resource ID of the multimedia material. Obtain this value from the ApsaraVideo VOD console |
| MediaResourceUrl | string | no | The access URL of the multimedia material. Specify either this parameter or the resource ID |
| MediaLayout | string | no | The layout position information of the multimedia material (JSON-encoded) |
| MattingType | string | yes | The image matting type. Valid values: green: green screen matting. blue: blue screen matting. complex: real-scene matting |
| MattingLayout | string | yes | The layout position information of the source stream after image matting (JSON-encoded) |

### Adds a stream delay configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-delay-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Domain | string | yes | The main streaming domain |
| App | string | yes | The AppName of the live stream. You can specify an asterisk (*) to match all AppNames under the domain name |
| Stream | string | yes | The name of the live stream. You can use the wildcard (*) to specify all StreamNames under the AppName |
| DelayTime | integer | yes | The duration for which the playback is delayed. The value must be an integer. Valid values: 16 to 3600. Unit: seconds |
| TaskTriggerMode | string | yes | The trigger mode. Valid values: PUBLISH_ONLY: Stream delay is triggered only by relevant parameters in the ingest URL. CONFIG_ONLY: Stream… |

### Creates an interactive messaging application by calling CreateLiveMessageApp
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-message-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppName | string | no | The application name. The name must be 2 to 16 characters in length |
| AuditType | integer | no | The security audit mode. Valid values: 0: default value. Security audit is disabled. 1: Built-in security audit. 2: Custom security audit |
| AuditUrl | string | no | The URL for custom security audit. This parameter is required when custom security audit is selected (AuditType=2). The URL must start… |
| EventCallbackUrl | string | no | The event callback URL for client logon, logout, join group, and leave group events. If this parameter is empty, event callbacks are… |
| DataCenter | string | no | The data center. Valid values: cn-shanghai: default value. Shanghai. ap-southeast-1: Singapore. When calling other interactive messaging… |
| MsgLifeCycle | integer | no | The storage duration tier for group messages within the application. Valid values: 0: default value. Messages are stored for 30 days. 1:… |

### Creates an interactive messaging group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-message-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| GroupId | string | yes | The ID of the group that you want to create. The group ID must be unique within your business. The ID can be up to 64 bytes in length and… |
| GroupName | string | no | The name of the group. The name can be up to 128 bytes in length |
| GroupInfo | string | no | The additional information about the group. The value can be up to 32 KB in length |
| Administrators | string | no | The list of administrators (JSON-encoded) |
| CreatorId | string | no | The ID of the group creator. The ID can be up to 64 bytes in length and can contain letters and digits |
| DataCenter | string | no | The data center. It must be the same as the data center that was specified when you called the… |

### Creates an Alibaba Cloud Global Accelerator (GA) instance and attaches it to a live streaming link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-private-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streamer streaming domain |
| AppName | string | yes | The application name |
| StreamName | string | yes | The live stream name |
| VideoCenter | string | yes | The live center. Valid values: cn-beijing, cn-shanghai, cn-shenzhen, cn-qingdao, ap-northeast-1, ap-southeast-5, eu-central-1,… |
| AccelerationType | string | yes | The acceleration type. Valid values: play: streaming acceleration. publish: stream ingest acceleration |
| AccelerationArea | string | yes | The acceleration channel |
| Reuse | string | yes | Specifies whether to reuse an existing acceleration channel. Valid values: yes: Reuse an existing acceleration channel. no: Create a new… |
| MaxBandwidth | string | no | The acceleration bandwidth. Unit: Mbit/s. This parameter is required when Reuse is set to no |
| InstanceId | string | no | The ID of the acceleration channel to reuse. This parameter is required when Reuse is set to yes |

### Creates a stream pulling and pushing task by calling CreateLivePullToPush
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-pull-to-push` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Region | string | yes | The region where the task is started. Valid values: ap-southeast-1 (Singapore) ap-southeast-5 (Indonesia) cn-beijing (Beijing) cn-shanghai… |
| TaskName | string | no | The task name, which supports fuzzy match. Default value: "" |
| StartTime | string | yes | The start time of the task. Format: yyyy-MM-dd T HH:mm:ss Z (UTC) |
| EndTime | string | yes | The end time of the task. Format: yyyy-MM-dd T HH:mm:ss Z (UTC). EndTime must be later than StartTime. EndTime must be later than the… |
| SourceType | string | yes | The source stream type. Valid values: live: live stream. vod: ApsaraVideo VOD resource. url: third-party video file resource |
| SourceProtocol | string | no | The source stream protocol. Valid values: rtmp srt http-flv hls This parameter is required only when SourceType is set to live. This… |
| SourceUrls | string | yes | The list of source stream URLs. For the live type, only one complete live streaming URL is supported. For the vod and url types, up to 30… |
| DstUrl | string | yes | The destination ingest URL. The rtmp protocol is supported. The maximum length is 2000 characters |
| RepeatNumber | integer | no | The number of times to repeat playback after the playlist finishes. Valid values: 0 (default): no repeat. -1: loop indefinitely. Other… |
| FileIndex | integer | no | The file index. Playback starts from the nth file |
| Offset | integer | no | The start offset from the beginning of the video file. Unit: seconds. The value must be greater than 0. Specifies the offset from the… |
| CallbackUrl | string | no | The HTTP callback URL. Default value: empty. The URL that receives task-related callbacks. The maximum length is 2000 characters. If this… |
| RetryInterval | integer | no | The retry interval. Unit: seconds. Valid values: 60 to 300. Default value: 60 |
| RetryCount | integer | no | The number of retries. Default value: 3 |
| ReqAuth | string | no | Specifies whether to add authentication to callbacks |
| AuthKey | string | no | The authentication key. The key must be 16 to 64 characters in length and can contain only printable ASCII characters (0x21-0x7e). The key… |
| NotifyItemSwitch | string | no | Specifies whether to receive callbacks when the playlist switches during non-live stream pulling and pushing tasks |

### Calls CreateLiveRealTimeLogDelivery to create a real-time log delivery configuration for a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-real-time-log-delivery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Project | string | yes | The ProjectName for real-time log delivery to SLS |
| Logstore | string | yes | The LogStoreName for real-time log delivery to SLS |
| Region | string | yes | The Region for real-time log delivery to SLS |
| DomainName | string | yes | The streaming domain |

### Creates a monitoring session
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-stream-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| MonitorName | string | yes | The name of the monitoring session |
| OutputTemplate | string | yes | The output template for the monitoring session. Valid values: lp_ld: low definition. lp_sd: standard definition. lp_hd: high definition.… |
| Domain | string | yes | The domain name to monitor |
| App | string | no | The application name for the output stream of the monitoring session. You can specify a custom name. If you do not specify this parameter,… |
| Stream | string | no | The name of the output stream for the monitoring session. If you do not specify this parameter, the system generates a random name |
| InputList | string | yes | The list of input streams to monitor. For more information, see the InputConfig table below |
| MonitorConfig | string | no | The alert threshold settings for monitoring. The value must be a JSON string. For more information, see the MonitorConfig table below |
| CallbackUrl | string | no | The webhook address. HTTP and HTTPS are supported |
| DingTalkWebHookUrl | string | no | The webhook URL of the DingTalk chatbot. To receive alert notifications, configure a DingTalk chatbot and enter its webhook URL, which can… |

### Creates an M3U8 index file for a specified time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-live-stream-record-index-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The streamer streaming domain |
| AppName | string | yes | The name of the application to which the stream belongs. The AppName must match the AppName in the ingest URL for the template to take… |
| StreamName | string | yes | The stream name. The StreamName must match the StreamName in the ingest URL for the template to take effect. To match all StreamName… |
| OssEndpoint | string | yes | The endpoint of the OSS bucket |
| OssBucket | string | yes | The name of the OSS bucket |
| OssObject | string | yes | The name of the recording file stored in OSS |
| StartTime | string | yes | The start time of the index file. TS files uploaded after this time are included in the index file. Specify the time in the yyyy-MM-dd T… |
| EndTime | string | yes | The end time of the index file. TS files uploaded before this time are included in the index file. Specify the time in the yyyy-MM-dd T… |
| EndTimeIncluded | string | no | Specifies whether to include the end time. If you set this parameter to true, the system attempts to include one additional TS file so… |

### You can call CreateMessageApp to create an interactive message application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-message-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppName | string | yes | The name of the interactive message application. The length must be 2 to 16 characters |
| AppConfig | string | no | The application configuration (JSON-encoded) |
| Extension | string | no | The extension field (JSON-encoded) |

### Creates a message group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-message-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the interactive messaging application |
| CreatorId | string | yes | The ID of the creator. The ID can be up to 36 characters in length and can contain only letters and digits |
| Extension | string | no | The extended field (JSON-encoded) |

### Creates a stream mixing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-mix-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain of the streamer. Only domain names in the China (Shanghai) (cn-shanghai) and China (Beijing) (cn-beijing) regions are… |
| LayoutId | string | yes | The layout ID. Valid values: MixStreamLayout-1-1 MixStreamLayout-2-1 MixStreamLayout-2-2 MixStreamLayout-2-3 MixStreamLayout-3-1… |
| InputStreamList | string | yes | The list of input streams for stream mixing. JSON array. Refer to InputStreamConfig below |
| OutputConfig | string | yes | The output configuration for stream mixing. The value is a JSON string. Refer to OutputConfig below |
| CallbackConfig | string | no | The callback URL. JSON array. When an event occurs, the live streaming server sends an HTTP POST request to this URL. The specific content… |

### Creates a WHIP ingest URL for an RTC channel
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-rtcwhip-stream-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClientToken | string | no | The idempotency parameter. An identifier used to distinguish whether multiple requests are the same request. Do not specify this parameter… |
| AppId | string | yes | The application ID. You can view your application IDs by choosing ApsaraVideo Live > Live+ > ApsaraVideo Real-time Communication >… |
| ChannelId | string | yes | The ID of the channel to join |
| UserId | string | yes | The user ID. The user ID must be unique among all users in the channel |
| DisplayName | string | yes | The display name of the user in the channel. Chinese and other characters are supported. To prevent the name from being too long, keep the… |
| ExpireTime | integer | no | The validity period of the stream ingest URL. Unit: seconds. Default value: 43200. If the validity period expires, ongoing streams that… |

### Creates an ingest URL for an RTMP stream in a channel
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-room-real-time-stream-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the ApsaraVideo Real-time Communication application. Only a single ID is supported. The value can contain uppercase and… |
| ChannelId | string | yes | The ID of the channel to join. Only a single ID is supported. The value can contain uppercase and lowercase letters, digits, underscores,… |
| UserId | string | yes | The user ID for the RTMP stream ingest. This value must not duplicate any other user ID in the channel. The value can contain uppercase… |
| DisplayName | string | yes | The display name of the RTMP stream in the channel. Maximum length: 40 characters |
| ExpireTime | integer | no | The validity period of the RTMP URL. Unit: seconds. Default value: 36000 (10 hours) |

### Creates a real-time subtitle task to transcribe an audio stream into text in real time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-rtc-asr-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Mode | string | yes | The stream mode. Valid values: live and rtc. The value live indicates a standard live stream such as RTMP |
| SDKAppID | string | no | The ApsaraVideo Real-time Communication application ID. This parameter is required when Mode is set to rtc. Otherwise, this parameter does… |
| ChannelID | string | no | The channel ID. This parameter is required when Mode is set to rtc. Otherwise, this parameter does not take effect |
| RtcUserId | string | no | The stream ingest user ID. This parameter is required when Mode is set to rtc. Only one value can be specified. Otherwise, this parameter… |
| StreamURL | string | no | The streaming URL. This parameter is required when Mode is set to live. Otherwise, this parameter does not take effect |
| Language | string | yes | The language of the source audio. Valid values: ja: Japanese. yue: Cantonese. fspk: Chinese-English free speech. en: English. cn: Chinese |
| CallbackURL | string | yes | The callback URL |
| AuthKey | string | no | The authentication key used to generate the MD5 signature for callback information. Two authentication fields are added to the request… |
| TranslateEnabled | string | no | Specifies whether to enable translation |
| TargetLanguages | string | no | The target translation language. Valid values: cn: Chinese. en: English. ja: Japanese |
| AutoTerminateEnabled | string | no | Specifies whether to automatically close the task when the stream disconnection exceeds the maximum delay. Default value: false |
| AutoTerminateDelay | integer | no | The automatic stream disconnection delay, in seconds. Valid values: 1 to 10 |
| ReportInterval | integer | no | The callback reporting interval, in milliseconds. Valid values: -1 to 500. -1: Does not accept intermediate results. Only full-sentence… |

### Creates an event subscription for stream mixing and relaying
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/create-rtc-mpuevent-sub` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application to subscribe to. You can view your application IDs by navigating to ApsaraVideo Live > Live+ > ApsaraVideo… |
| ChannelIds | string | no | The channel IDs of the stream mixing tasks for which you want to receive callbacks. You can specify multiple channel IDs separated by… |
| CallbackUrl | string | yes | The callback URL. For the URL format, refer to the callback content specifications below. The callback URL protocol must be HTTP or HTTPS.… |

### Deletes a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The ID of the production studio. Make sure that you specify the correct CasterId. If you created a production studio by calling the… |

### Deletes a component from a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster-component` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The ID of the production studio. If you create a production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| ComponentId | string | yes | The component ID. If you add a component to the production studio by calling the https://help.aliyun.com/document_detail/2848030.html… |

### Deletes an episode from a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster-episode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The production studio ID. If you created the production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| EpisodeId | string | yes | The episode ID. If you added the episode by calling the https://help.aliyun.com/document_detail/2848068.html operation, use the EpisodeId… |

### Deletes an episode list in a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster-episode-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ProgramId | string | yes | The ID of the episode list. To obtain the ID, call the https://help.aliyun.com/document_detail/2848071.html operation and find the value… |

### Deletes a layout in a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The ID of the production studio. If you call the https://help.aliyun.com/document_detail/2848009.html operation to create a production… |
| LayoutId | string | yes | The layout ID. If you call the https://help.aliyun.com/document_detail/2848025.html operation to add a layout to the production studio,… |

### Deletes the episode list for carousel playback in a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster-program` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region |
| CasterId | string | yes | The ID of the production studio. If you create a production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |

### Deletes the scene configuration of a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster-scene-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The production studio ID. If you created the production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| SceneId | string | yes | The scene ID |
| Type | string | yes | The scene configuration type. Valid values: Component: component configuration. Layout: layout configuration. All: component and layout… |

### Removes an input source from a production studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-caster-video-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| CasterId | string | yes | The ID of the production studio. If you created the production studio by calling the https://help.aliyun.com/document_detail/2848009.html… |
| ResourceId | string | yes | The resource ID. If you added the video resource by calling the https://help.aliyun.com/document_detail/2848020.html operation, use the… |

### Closes a channel, which causes all current members in the channel to leave, but does not affect subsequent…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | no | The application ID. Only a single ID is supported. This parameter is required. If this parameter is not specified, the service returns… |
| ChannelId | string | no | The ID of the channel that has been joined. Only a single ID is supported. This parameter is required. If this parameter is not specified,… |

### Deletes a custom transcoding template for stream mixing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-custom-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Template | string | yes | The name of the template to delete |

### Deletes an edge transcoding task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-edge-transcode-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ClusterId | string | yes | The data center ID. You can call ListEdgeTranscodeJob to obtain all task information and use the ClusterId associated with the task that… |
| JobId | string | yes | The edge transcoding task ID |

### Deletes a callback that is used to subscribe to channel or user events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-event-sub` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |
| SubscribeId | string | yes | The subscription ID. You can obtain the ID from the response to the https://help.aliyun.com/document_detail/2848209.html operation |

### Deletes a subtitle rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-aiproduce-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| RulesId | string | no | The subtitle rule ID |
| SuffixName | string | no | The subtitle suffix. This parameter is required. Otherwise, the InvalidParameter error is returned. Set this parameter to the value of… |
| Domain | string | yes | The primary streaming domain |
| App | string | yes | The name of the live stream application |

### Deletes a virtual studio template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-aistudio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| StudioId | string | yes | The ID of the template. The ID is returned by the CreateLiveAIStudio operation |

### Deletes a specified subtitle template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-aisubtitle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| SubtitleId | string | yes | The ID of the caption template |
| SubtitleName | string | no | The name of the caption template. The name can contain only digits, letters, and hyphens (-). A hyphen cannot be the first character |

### Deletes a recording configuration at the AppName level
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-app-record-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The AppName of the live stream |
| StreamName | string | no | The name of the live stream |

### Deletes the snapshot configuration for live streams in an application. The deletion takes effect after you…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-app-snapshot-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The name of the application to which the live stream belongs. The value of this parameter must be the same as the application name in the… |

### Deletes an audio moderation configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-audio-audit-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The AppName of the live stream. Set AppName to an asterisk (*) to match all AppNames under the domain |
| StreamName | string | yes | The stream name. Set StreamName to an asterisk (*) to match all streams in the AppName |

### Deletes the callback configuration for automated audio review from a streaming domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-audio-audit-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |

### Deletes a live center stream relay configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-center-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The name of the live stream application. The AppName you specify must be the same as the AppName of the live stream to be relayed for the… |
| StreamName | string | yes | The name of the live stream. You can view the StreamName on the https://help.aliyun.com/document_detail/197397.html page |
| DstUrl | string | no | The third-party streaming URL to which the stream is relayed |

### Deletes a stream delay configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-delay-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Domain | string | yes | The streaming domain |
| App | string | yes | The AppName of the live stream. You can specify an asterisk (*) to match all AppNames under the domain name |
| Stream | string | yes | The name of the live stream. You can use the wildcard (*) to specify all StreamNames under the AppName |

### Deletes the configuration of callbacks for video moderation results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-detect-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |

### Deletes all records of the specified live streaming domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The ingest or streaming domain to delete |

### Deletes the mapping between a streaming domain and an ingest domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-domain-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PushDomain | string | yes | The ingest domain. The type of the domain name is liveEdge |
| PullDomain | string | yes | The streaming domain. The type of the domain name is liveVideo |

### Deletes the mapping between a main streaming domain and a sub-streaming domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-domain-play-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| PlayDomain | string | yes | The sub-streaming domain |
| PullDomain | string | yes | The main streaming domain |

### Deletes a live stream relay configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-edge-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The ingest domain. Each domain name has only one live stream relay configuration |

### Deletes a configuration of triggered stream pulling
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-lazy-pull-stream-info-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The name of the application. To delete configurations of triggered stream pulling for all applications, set it to ali_all_app |

### Deletes an interactive messaging group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-message-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| GroupId | string | yes | The ID of the group that you want to delete |
| OperatorId | string | no | The ID of the user who performs the deletion operation. The ID can be up to 64 bytes in length and can contain only letters and digits |
| DataCenter | string | no | The data center. It must be the same as the data center that was specified when you called the… |

### Deletes a message that was sent to an interactive messaging group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-message-group-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| GroupId | string | yes | The group ID |
| MessageId | string | yes | The ID of the message that you want to delete. Set this parameter to the value of MsgTid that you specified when you called the… |
| DataCenter | string | no | The data center. It must be the same as the data center that was specified when you called the… |
| DeleterId | string | no | The ID of the user who deletes the message. The ID must be up to 64 bytes in length and can contain letters and digits |
| DeleterInfo | string | no | The additional information about the user who performs the deletion operation. The value can be up to 512 bytes in length |

### Deletes (recalls) a specific one-to-one chat message
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-message-user-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| ReceiverId | string | yes | The ID of the user who receives the delete message notification. The value consists of uppercase and lowercase letters and digits, and… |
| MessageId | string | yes | The ID of the message to be deleted, which corresponds to the MsgTid in the send message operation. The value consists of uppercase and… |
| DeleterId | string | no | The ID of the user who initiates the message deletion. The value consists of uppercase and lowercase letters and digits, and cannot exceed… |
| DeleterInfo | string | no | The extended information of the user who initiates the message deletion. The value cannot exceed 512 bytes in length |
| DataCenter | string | no | The data center, which must be the same as the data center specified in https://help.aliyun.com/document_detail/2848162.html. Currently,… |

### Deletes a live stream encapsulation configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-package-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The AppName of all live streams. An asterisk (*) matches all AppNames |
| StreamName | string | yes | The stream name. An asterisk (*) matches all streams under the specified AppName |

### Unbinds an Alibaba Cloud Global Accelerator (GA) instance from a live streaming link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-private-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The application name |
| StreamName | string | yes | The live stream name |
| AccelerationType | string | yes | The acceleration type. Valid values: play: streaming acceleration. publish: stream ingest acceleration |

### Deletes a scheduled stream pulling configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-pull-stream-info-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The name of the application to which the live stream belongs. Call https://help.aliyun.com/document_detail/2847818.html to query the… |
| StreamName | string | yes | The name of the stream. Call https://help.aliyun.com/document_detail/2847818.html to query the stream name |

### Deletes a stream pulling-to-pushing task by calling DeleteLivePullToPush
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-pull-to-push` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| TaskId | string | yes | The task ID |
| Region | string | yes | The region where the task is started. Valid values: ap-southeast-1 (Singapore) ap-southeast-5 (Indonesia) cn-beijing (Beijing) cn-shanghai… |

### Deletes a Logstore for real-time log delivery
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-real-time-log-logstore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Project | string | yes | The name of the Simple Log Service (SLS) project for real-time delivery |
| Logstore | string | yes | The name of the SLS Logstore for real-time delivery |
| Region | string | yes | The region of the SLS project for real-time delivery |

### Deletes a real-time log delivery configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-realtime-log-delivery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain name. To specify multiple domain names, separate them with commas (,) |
| Project | string | yes | The name of the Simple Log Service (SLS) project to which logs are delivered in real time |
| Logstore | string | yes | The name of the SLS Logstore to which logs are delivered in real time |
| Region | string | yes | The region where the SLS project is located |

### Deletes the configuration of callbacks for live stream recording under a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-record-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |

### Deletes a Live-to-VOD configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-record-vod-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The AppName of the live stream. View AppNames on the https://help.aliyun.com/document_detail/197397.html page |
| StreamName | string | no | The name of the stream. View StreamNames on the https://help.aliyun.com/document_detail/197397.html page |

### Deletes a video moderation configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-snapshot-detect-porn-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The name of the application to which the live stream belongs. You can call the https://help.aliyun.com/document_detail/2847918.html… |

### Deletes the snapshot callback configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-snapshot-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The main streaming domain |

### You can call the DeleteLiveSpecificStagingConfig operation to delete domain name configurations in a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-specific-staging-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The accelerated domain name |
| ConfigId | string | yes | The configuration ID. To specify multiple IDs, separate them with commas (,). To obtain the configuration ID, see… |

### Deletes blocking configurations for a specific live stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-stream-block` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The AppName of the live stream. View AppNames on the https://help.aliyun.com/document_detail/197397.html page |
| StreamName | string | yes | The name of the live stream. View StreamNames on the https://help.aliyun.com/document_detail/197397.html page |

### Deletes an active merged stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-stream-merge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain |
| AppName | string | yes | The AppName for the merged stream. View the AppName on the https://help.aliyun.com/document_detail/606583.html page |
| StreamName | string | yes | The StreamName for the merged stream. View the StreamName on the https://help.aliyun.com/document_detail/606583.html page |

### Deletes a monitoring session
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-stream-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region |
| MonitorId | string | yes | The ID of the monitoring session. The MonitorId is returned in the response of the https://help.aliyun.com/document_detail/2848129.html… |

### Deletes the index files of live stream recordings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-stream-record-index-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| RecordId | string | yes | The array of index file IDs (JSON-encoded) |
| DomainName | string | yes | The main streaming domain |
| AppName | string | yes | The AppName of the live stream |
| StreamName | string | yes | The stream name |
| RemoveFile | string | yes | Specifies whether to delete the associated OSS objects at the same time. Valid values: true: Deletes. false: Does not delete |

### Deletes a transcoding configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-stream-transcode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Domain | string | yes | The main streaming domain |
| App | string | yes | The AppName of the live stream |
| Template | string | yes | The transcoding template ID. Valid values: Standard transcoding: lld: low definition lsd: standard definition lhd: high definition lud :… |

### Deletes a specified watermark template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-stream-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| TemplateId | string | yes | The ID of the watermark template. The template ID is returned in the response of the https://help.aliyun.com/document_detail/2848096.html… |

### Deletes a watermark rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-stream-watermark-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Domain | string | yes | The main streaming domain |
| App | string | no | The AppName of the live stream |
| Stream | string | no | The stream name. The following rules apply: To match a specific stream, enter the full stream name. Example: liveStreamA. Use a wildcard… |
| RuleId | string | no | The ID of the watermark rule. Get this ID from the response of the https://help.aliyun.com/document_detail/2848100.html operation |

### Deletes the callback configuration of stream ingest for an ingest domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-live-streams-notify-url-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The ingest domain |

### Call DeleteMessageApp to delete an interactive message application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-message-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the interactive message application to be deleted. Only one application ID can be specified |

### Deletes a stream mixing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-mix-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DomainName | string | yes | The streaming domain of the streamer |
| AppName | string | no | The application name |
| StreamName | string | no | The stream name of the stream mixing task |
| MixStreamId | string | yes | The stream mixing task ID. If you created the stream mixing task by calling the https://help.aliyun.com/document_detail/2848087.html… |

### Deletes an entire playlist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-playlist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ProgramId | string | yes | The ID of the playlist. You can obtain the playlist ID from the ProgramId parameter in the response of the… |

### Deletes items from a playlist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-live/delete-playlist-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ProgramId | string | yes | The ID of the playlist. If you add items to the playlist by calling the https://help.aliyun.com/document_detail/2848078.html operation,… |
| ProgramItemIds | string | yes | A list of playlist item IDs |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-component" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraVideo Live API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-live/add-caster-component with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraVideo Live API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ApsaraVideo Live itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ApsaraVideo Live API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-live.

### What is the status of the Alibaba Cloud ApsaraVideo Live API?
Needs your own provider key (bring your own key)