Starting a Virtual Avatar Intelligent Interaction Task

project_id

Yes

String

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

room_id

Yes

String

Interactive dialog ID. For details about how to obtain the ID, see Creating an Interactive Dialog.

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.

region

No

String

Region where the computing power is provided.

• cn-north-4: CN North-Beijing4

• cn-southwest-2: CN Southwest-Guiyang1

client_id

No

String

Service ID.

room_type

No

String

Room type for interactive dialogs with virtual avatars.

• RTC: RTC room

• METALINK: Metalink room

Default value:

RTC

X-Request-Id

String

Request ID.

job_id

String

Interactive dialog task ID.

rtc_room_info

RTCRoomInfoList object

RTC room information.

chat_subtitle_config

ChatSubtitleConfig object

Dialog subtitle configuration

video_config

ChatVideoConfigRsp object

Video output configuration.

voice_config_list

Array of VoiceConfigRsp objects

Voice configuration parameter list.

chat_video_type

String

Interactive dialog device configuration.

• COMPUTER: PC

• MOBILE: mobile phone

• Hub: large screen

is_transparent

Boolean

Whether the background is transparent.

Default value:

false

region

String

Region where the computing power is provided.

• cn-north-4: CN North-Beijing4

• cn-southwest-2: CN Southwest-Guiyang1

default_language

String

Default language, which is used by the intelligent interaction APIs. Default value: CN

• CN: Simplified Chinese

• EN: English

• ESP: Spanish (supported only outside China)

• por: Portuguese (supported only outside China)

• Arabic: Arabic (supported only outside China)

• Thai: Thai (supported only outside China)

Default value:

CN

app_id

String

RTC application ID.

room_id

String

RTC room ID.

users

Array of RTCUserInfo objects

Information about users joining an RTC room.

user_type

String

User type.

• CAPTURE: Live assistant, which pushes video streams captured by cameras to RTC rooms.

• ANIMATION: Visual control service, which pulls video streams from RTC rooms to generate motion data.

• RENDER: Rendering service, which renders motion data into virtual human animations.

• PLAYER: Common viewer, who can watch the original video stream or virtual human animation video stream.

• INFERENCE_USER: Virtual human inference user, who receives audio streams from and pushes video streams to an RTC room.

• END_USER: Device user, who receives video streams from and pushes audio streams to an RTC room.

user_id

String

RTC user ID.

signature

String

RTC authentication token.

ctime

Long

Validity period. Timestamp, in seconds.

Value range:

0~4294967295

dx

Integer

Details:

Coordinates of the pixel in the upper left corner of the subtitle box.

The video resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Value range:

0~1920

dy

Integer

Details:

Coordinates of the pixel in the upper left corner of the subtitle box.

The video resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Value range:

0~1920

width

Integer

Details:

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

The image layout resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Value range:

1~7680

height

Integer

Details:

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

The image layout resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Value range:

1~7680

width

Integer

Video width.

Unit: pixel.

The value ranges from 320 to 2560.

Value range:

0~3840

height

Integer

Video height.

Unit: pixel.

The value ranges from 320 to 2560.

Value range:

0~3840

voice_asset_id

String

Speech synthesis feature string

speed

Integer

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

Value range:

50~200

Default value:

100

pitch

Integer

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

Value range:

50~200

Default value:

100

volume

Integer

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

Value range:

90~240

Default value:

140

provider

String

Third-party TTS vendor. Options:

• XIMALAYA: Himalaya TTS

• HUAWEI_EI: EI TTS

• MOBVOI: Mobvoi TTS

language

String

Language type. Default value: CN

• CN: Simplified Chinese

• EN: English

• ESP: Spanish (supported only outside China)

• por: Portuguese (supported only outside China)

• Arabic: Arabic (supported only outside China)

• Thai: Thai (supported only outside China)

Default value:

CN

language_desc

String

Language 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.

202

Succeeded.

400

Parameters error, including the error code and its description.

401

Authentication is not performed or fails.

500

Internal service error.