Querying Intelligent Livestreaming Script Details

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

room_id

Yes

String

Script ID.

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.

X-Request-Id

String

Request ID.

room_name

String

Livestreaming room name.

room_description

String

Livestreaming room description.

room_type

String

Live room type.

• NORMAL: general live room. The room always exists and can start and stop livestreaming at any time.
• TEMP: temporary live room. After a livestreaming task is complete, the live room is automatically cleared.
• TEMPLATE: live room template

scene_scripts

Array of LiveVideoScriptInfo objects

Default livestreaming script list.

interaction_rules

Array of LiveRoomInteractionRuleInfo objects

Interaction rule list.

play_policy

PlayPolicy object

Script playback policy.

video_config

VideoConfig object

Video output configuration.

output_urls

Array of strings

Address of the third-party livestreaming platform for RTMP video stream push.

stream_keys

Array of strings

Stream key of the third-party livestreaming platform for RTMP video stream push, which corresponds to the ingest URL.

backup_model_asset_ids

Array of strings

Asset ID of the alternative virtual streamer (only image assets, excluding timbre).

live_event_callback_config

LiveEventCallBackConfig object

Live event callback notification configuration.

rtc_callback_config

RTCLiveEventCallBackConfig object

RTC callback event configuration. Compatible processing. If the configuration is not carried, LIVE_PROGRESS is subscribed by default.

review_config

ReviewConfig object

Content review configuration.

shared_config

SharedConfig object

Sharing configuration.

view_mode

String

Landscape or portrait mode. Default value: VERTICAL

• LANDSCAPE: landscape
• VERTICAL: portrait

co_streamer_config

CoStreamerConfig object

Co-streamer configuration

priv_data

String

Private data, which is filled in by the user and carried back as it is.

room_id

String

Livestreaming room ID.

create_time

String

Time when a livestreaming room is created. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

update_time

String

Time when a livestreaming room is updated. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

cover_url

String

Livestreaming room thumbnail URL.

thumbnail

String

New URL of the live room thumbnail

room_state

String

Live room status.

• ENABLE: The live room is available.
• DISABLE: The live room is unavailable. The cause is described in error_info.
• BLOCKED: The live room has been blocked. The cause is described in error_info.

error_info

ErrorResponse object

Error messages of a virtual human live room.

script_id

String

Script ID.

script_name

String

Script name.

script_description

String

Script description.

dh_id

String

Virtual human ID, which corresponds to the combination of image and timbre.

model_asset_id

String

Asset ID of a virtual human model.

voice_config

VoiceConfig object

Voice configuration parameter.

background_config

Array of BackgroundConfigInfo objects

Background configuration.

layer_config

Array of LayerConfig objects

Layer configuration.

shoot_scripts

Array of LiveShootScriptItem objects

Shooting script list.

background_type

String

Background type.

• IMAGE: image, which is used as the image for 3D virtual human demonstration materials or virtual avatar background.
• IMAGE_2D: image, which is used as the background image in the 2D scene for 3D virtual broadcasters.
• VIDEO: video
• AUDIO: audio

background_config

String

Background file URL.

background_color_config

String

RGB color value of a solid color background.

background_asset_id

String

Background asset ID.

layer_type

String

Layer type.

• HUMAN: person layer
• IMAGE: image layer
• VIDEO: video layer
• TEXT: material text layer

asset_id

String

ID of the asset overlaid on a video. You do not need to set this parameter for external assets.

group_id

String

Groups materials in multiple scenes. Materials with the same group_id share location information when they are applied globally.

position

LayerPositionConfig object

Layer position configuration.

size

LayerSizeConfig object

Layer size configuration.

image_config

ImageLayerConfig object

Material image layer configuration.

video_config

VideoLayerConfig object

Material video layer configuration.

text_config

TextLayerConfig object

Material text layer configuration.

dx

Integer

X axis position of the pixel in the upper left corner of the image. The coordinate of the upper left corner of the canvas is 0x0.

dy

Integer

Y axis position of the pixel in the upper left corner of the image. The coordinate of the upper left corner of the canvas is 0x0.

layer_index

Integer

Layer sequence of an image, video, or person image.

width

Integer

Width (in pixel) of the layer image (relative to the canvas size).

height

Integer

Height (in pixel) of the layer image (relative to the canvas size).

image_url

String

Image file URL.

video_url

String

Video file URL.

video_cover_url

String

Video thumbnail file URL.

loop_count

Integer

Number of times that a video is played cyclically.

text_context

String

Text of the text layer. The content must be encoded using Base64.

For example, if you want to add the text watermark "Test text watermark", set text_context to 5rWL6K+V5paH5a2X5rC05Y2w.

font_name

String

Font. The following fonts are supported:

• HarmonyOS_Sans_SC_Black: HarmonyOS bold
• HarmonyOS_Sans_SC_Regular: HarmonyOS normal
• HarmonyOS_Sans_SC_Thin: HarmonyOS light
• fzyouh: Square & lean

font_size

Integer

Font size (pixel).

The value ranges from 4 to 120.

font_color

String

Font color. RGB color value.

sequence_no

Integer

Script No.

title

String

Paragraph title.

text_config

TextConfig object

Script configuration.

audio_config

LiveAudioConfig object

Live audio configuration.

text

String

Script.

Two modes are supported: plain text mode and tag mode.

Plain text mode

Plain text mode, for example, "Hello, everyone, I'm a virtual streamer."

Tag mode

For details about the definition of SSML tags, see SSML Definition of Text Control.

asset_id

String

ID of the inserted audio asset. You do not need to set this parameter for external assets.

audio_url

String

Audio URL. Only the MP3 format is supported. The size is less than 100 MB. The output is automatically converted to mono 16 kHz for sampling.

subtitle_url

String

URL of the subtitle file of the audio. Only the SRT format is supported. The size is less than 1 MB.

rule_index

String

Rule index.

rule_name

String

Rule name.

enabled

Boolean

Whether to enable.

event_type

Integer

Event type. - 1: on-screen comment - 2: users joining a live room - 3: giving likes - 4: sending gifts - 10: preset wording

hit_condition

HitCondition object

Hit condition.

trigger

TriggerProcess object

Trigger

review_config

ReviewConfig object

Content review configuration.

group_id

String

Interaction rule library ID, which is carried when a rule is imported from the interaction rule library.

group_name

String

Interaction rule library name, which is carried when a rule is imported from the interaction rule library.

enabled_scenes

Array of strings

Scenario where a rule is enabled. Set this parameter when it is enabled in some scenarios. If this parameter is not specified, the rule is enabled in all scenarios.

relation

String

Condition relationship. The value And or Or RESERVED indicates that the general reply does not check other matching conditions.

priority

Integer

Priority. A smaller value indicates a higher priority. The value ranges from 0 to 999. The default value is 500. This parameter is optional.

tags

Array of HitConditionTag objects

Matching relationship configuration

tag

String

Key fields in the event content.

operation

String

Field processing.

• SUM: accumulation
• AVG: average
• COUNT: count
• NONE: no processing

match

String

Match type.

• EQUAL: completely equal
• REGEX: regular expression match
• MATH_GT: greater than
• MATH_GE: greater than or equal to
• MATH_LT: less than
• MATH_LE: less than or equal to
• MATH_EQ: numerically equal

value

String

Match value

time_window

Integer

Processing suppression duration, in second.

–1 indicates the entire livestreaming.

0 indicates no suppression. It is triggered each time.

reply_mode

String

Reply type.

• SYSTEM_REPLY: automatic reply based on the preset script
• CALLBACK: callback to other services, with the preset script
• SHOW_LAYER: overlaid layer display, which does not affect the script
• INTELLIGENT_REPLY: script of an intelligent reply

layer_config

SmartLayerConfig object

Intelligent layer configuration.

extra_layer_config

SmartLayerConfig object

Additional layer, which is used together with the second layer when dynamic text needs to be displayed for products.

reply_texts

Array of strings

Reply scripts.

reply_audios

Array of ReplyAudioInfo objects

Reply audio set. Set audio_url.

reply_order

String

Reply sequence.

• RANDOM: random
• ORDER: sequential loop

reply_role

String

Reply role. The default value is STREAMER.

• STREAMER: streamer
• CO_STREAMER: co-streamer

robot_id

String

Bot ID.

layer_type

String

Layer type.

• IMAGE: image layer
• VIDEO: video layer
• TEXT: text layer

asset_id

String

ID of the asset overlaid on a video. You do not need to set this parameter for external assets.

position

LayerPositionConfig object

Layer position configuration.

size

LayerSizeConfig object

Layer size configuration.

image_config

SmartImageLayerConfig object

Image layer configuration.

video_config

SmartVideoLayerConfig object

Video layer configuration.

text_config

SmartTextLayerConfig object

Video layer configuration.

image_url

String

Image file URL.

display_duration

Integer

Image display duration, in second.

• 0 Display duration rule: If reply_texts and reply_audios are carried, the duration is the same as the voice playback duration.

  If reply_texts and reply_audios are not carried, the duration is the same as the voice playback duration of the matched keyword.

video_url

String

Video file URL.

video_cover_url

String

Video thumbnail file URL.

display_duration

Integer

Video display duration, in second.

• 0 Display duration rule: If reply_texts and reply_audios are carried, the duration is the same as the voice playback duration.

  If reply_texts and reply_audios are not carried, the duration is the same as the voice playback duration of the matched keyword.

text_type

String

Text type.

• DYNAMIC: dynamic text, which requires keyword replacement
• STATIC: static text

text_context

String

Text.

font_name

String

Font. The following fonts are supported:

• HarmonyOS_Sans_SC_Black: HarmonyOS bold
• HarmonyOS_Sans_SC_Regular: HarmonyOS normal
• HarmonyOS_Sans_SC_Thin: HarmonyOS light
• fzyouh: Square & lean

font_size

Integer

Font size (pixel).

The value ranges from 4 to 120.

font_color

String

Font color. RGB color value.

display_duration

Integer

Text display duration, in second.

• 0 Display duration rule: If reply_texts and reply_audios are carried, the duration is the same as the voice playback duration.

  If reply_texts and reply_audios are not carried, the duration is the same as the voice playback duration of the matched keyword.

audio_url

String

Audio URL.

audio_name

String

Audio name.

repeat_count

Integer

Number of times that a script is played repeatedly.

The value –1 indicates that the playback is repeated until it is stopped manually.

The value 0 indicates that it is played only once.

If the value is n, the actual number of running times is n + 1.

auto_play_script

Boolean

Indicates whether to automatically play a script.

true: The script is automatically played after the task is initialized.

false: After the task is initialized, the script is not played until signal appears.

play_mode

String

Control mode. The default value is TEXT.

TEXT: text control, that is, TTS is used

AUDIO: speech control

NO_PRESET: no preset script, that is, manual control is used

random_play_mode

String

Random broadcast mode.

• NONE: Random broadcast is disabled.
• SCENE: Random broadcast by scene is enabled. Paragraphs in a scene are broadcast in sequence.
• SCRIPT_ITEM: Random broadcast by paragraph is enabled. Scenes are broadcast in sequence.
• SCENE_AND_SCRIPT_ITEM: Scenes and paragraphs are broadcast randomly.

need_independent_capture_client

Boolean

Whether an independent data collection device is required

clip_mode

String

Clipping mode of the output video. Default value: RESIZE.

• RESIZE: video scaling
• CROP: video cropping

codec

String

Video encoding format and video file format.

• H264: H.264 encoding, MP4 file output
• VP8: VP8 encoding, WebM file output

bitrate

Integer

Average output bitrate.

Unit: kbit/s

The value ranges from 40 to 30,000.

width

Integer

Video width.

Unit: pixel.

height

Integer

Video height.

Unit: pixel.

frame_rate

String

Frame rate.

Unit: FPS

is_subtitle_enable

Boolean

Whether the output video is subtitled. The default value is false.

• true: Displays the subtitle.
• false: Hides the subtitle.

subtitle_config

SubtitleConfig object

Subtitle configuration.

dx

Integer

Coordinates of the pixel in the upper left corner of the cropped video.

This parameter takes effect when clip_mode is set to crop.

dy

Integer

Coordinates of the pixel in the upper left corner of the cropped video.

This parameter takes effect when clip_mode is set to crop.

is_enable_super_resolution

Boolean

Whether super resolution is enabled for a video.

dx

Integer

Coordinates of the pixel in the lower left corner of the subtitle.

dy

Integer

Coordinates of the pixel in the lower left corner of the subtitle.

font_name

String

Font. The following fonts are supported:

• HarmonyOS_Sans_SC_Black: HarmonyOS bold
• HarmonyOS_Sans_SC_Regular: HarmonyOS normal
• HarmonyOS_Sans_SC_Thin: HarmonyOS light

font_size

Integer

Font size.

The value ranges from 4 to 120.

h

Integer

Subtitle box height

w

Integer

Subtitle box width

live_event_type_callback_url

String

Live event callback URL. HTTPS URL, which must contain an authentication string.

auth_type

String

Authentication type.

• None: The URL contains authentication.
• MSS_A: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are added to the URL. Value format: hwSecret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)&hwTime=hex(timestamp)
• MSS_A_HEAD: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are placed in Head.

  Value format: x-hw-mss-secret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)

  x-hw-mss-time=hex(timestamp)

• MEITUAN_DEFAULT: This parameter is used only for Meituan's API callback.

key

String

Key

callback_event_type

Array of strings

Live event types in callbacks.

Currently, only the following options are supported:

• SHOOT_SCRIPT_SWITCH: script paragraph switching event
• RTMP_STREAM_STATE_CHANGE: RTMP link change callback event
• REPLY_COMMAND_FINISH: Playback is complete.

  The callback event structure is defined as follows:

• event_type: event type
• message: event description

  The SHOOT_SCRIPT_SWITCH event callback is defined as follows:

{
  "event_type":  "SHOOT_SCRIPT_SWITCH",
  "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"Product 1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"Paragraph 2\"}"
}

The RTMP_STREAM_STATE_CHANGE callback is defined as follows:

{
  "event_type":  "RTMP_STREAM_STATE_CHANGE",
  "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}"
}

The value of state can be CONNECTING, CONNECTED, DISCONNECTED, RECONNECTING, or END.

The REPLY_COMMAND_FINISH callback is defined as follows:

{
  "event_type":  "REPLY_COMMAND_FINISH",
  "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"reply_id\":\"e87104f76d7546ce8a46ac6b04c49c3c"}"
}

rtc_callback_event_type

Array of strings

Live event types in RTC callbacks.

Currently, only the following options are supported:

LIVE_PROGRESS: live script progress notification

REPLY_COMMAND_FINISH: Playback is complete.

The callback event structure is defined as follows:

• message_type: message type
• data: message description

  The LIVE_PROGRESS event callback is defined as follows:

{
    "message_type": "live_progress_notify",
    "data": {
        "script_name": "Scene 1",
        "shoot_script_sequence_no": 2,
        "shoot_script_title": "Greeting",
        "offset": "247",
        "reply_id": "e87104f76d7546ce8a46ac6b04c49c3c"
    }
}

The REPLY_COMMAND_FINISH callback is defined as follows:

{
  "message_type": "reply_command_finish_notify",
  "data":"{
    "reply_id":"e87104f76d7546ce8a46ac6b04c49c3c"
  }"
}

no_need_review

Boolean

Content review whitelist. This feature is available only for users in the whitelist. The auto review policies apply to other users.

shared_type

String

Sharing type.

• PRIVATE: accessible only to the current tenant
• PUBLIC: accessible to all tenants. Currently, only system assets are accessible to all tenants.
• SHARED: accessible to specified tenants. The tenants are specified by the owner.

shared_state

String

Sharing status.

• PUBLISHED: published. The template is available.
• DRAFT: draft. The template is being edited and can be viewed only by the owner.
• REVIEW: The template is being reviewed. The template cannot be edited and can be viewed only by the owner/reviewer.

expire_time

String

Time when the sharing expires. If this parameter is left blank, the sharing never expires.

allowed_project_ids

Array of strings

Tenants allowed to access the asset.

voice_config

VoiceConfig object

Voice configuration parameter.

streamer_action

String

Behavior of the streamer when the co-streamer speaks.

• SILENCE: silent
• VOLUME_DOWN: decreased volume

voice_asset_id

String

Timbre asset ID.

speed

Integer

Speech speed.

The value defaults to 100 and ranges from 50 to 200.

pitch

Integer

Pitch.

The value defaults to 100 and ranges from 50 to 200.

volume

Integer

Volume.

The value defaults to 140 and ranges from 90 to 240.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

200

Succeeded.

400

Parameters error, including the error code and its description.

401

Authentication is not performed or fails.

404

No content.

500

Internal service error.