Help Center/ MetaStudio/ API Reference/ Intelligent Interaction/ Intelligent Interaction Management/ Virtual Avatar Dialog Task Management/ Querying Virtual Avatar Intelligent Interaction Tasks
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Virtual Avatar Intelligent Interaction Tasks

Function

Queries virtual avatar intelligent interaction tasks.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/digital-human-chat/smart-chat-rooms/{room_id}/smart-chat-jobs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

state

No

String

Task status. By default, all statuses are selected.

Multiple statuses can be queried. Use commas (,) to separate them,

for example, state=CREATING,PUBLISHED.

offset

No

Integer

Offset where the query starts.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Number of items displayed on each page.

Value range:

1~100

Default value:

10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

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 a request is sent. This parameter is mandatory for AK/SK authentication.

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.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

count

Integer

Total number of interactive dialog tasks.

Value range:

0~2147483647

smart_chat_jobs

Array of SmartChatJobBaseInfo objects

List of interactive dialog tasks.
Table 6 SmartChatJobBaseInfo

Parameter

Type

Description

job_id

String

Interactive dialog task ID.

state

String

Interactive dialog task status.

  • WAITING: The task is waiting for execution.

  • PROCESSING: The task is being executed.

  • SUCCEED: The task has been completed.

  • FAILED: Task execution failed.

  • DELETING: The task is being deleted.

duration

Float

Interactive dialog duration, in seconds.

Value range:

0~2147483647

start_time

String

Start time of an interactive dialog task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

end_time

String

End time of an interactive dialog task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

error_info

ErrorResponse object

Error information of an interactive dialog task.

create_time

String

Creation time of an interactive dialog task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

lastupdate_time

String

Last update time of an interactive dialog task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

chat_subtitle_config

SmartChatSubtitleConfig object

Dialog subtitle configuration

video_config

SmartChatVideoConfig object

Video output configuration.

voice_config_list

Array of SmartChatVoiceConfig objects

Voice configuration parameter list.

chat_video_type

String

Interactive dialog device.

  • COMPUTER: PC

  • MOBILE: mobile phone

  • Hub: large screen

is_transparent

Boolean

Whether the background is transparent.

Default value:

false

default_language

String

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

  • CN: 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

client_id

String

clientId

is_pool_mode

Boolean

Whether the resource pool mode is used.

Default value:

false

job_finish_reason

String

Reason for ending a dialog.

  • NORMAL: The task ends normally.

  • MUTE_TIMEOUT: The task ends because the request for muting timed out.
Table 7 ErrorResponse

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.
Table 8 SmartChatSubtitleConfig

Parameter

Type

Description

dx

Integer

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

NOTE:

  • 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

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

NOTE:

  • 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

Width (in pixels) of the image overlay (relative to the preview area size).

NOTE:
The preview area 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

Height (in pixels) of the image overlay (relative to the preview area size).

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

Value range:

1~7680
Table 9 SmartChatVideoConfig

Parameter

Type

Description

width

Integer

Video width.

Unit: pixel

The value ranges from 320 to 2560.

NOTE:

  • When clip_mode is set to RESIZE, the following resolutions are supported: 1920 x 1080, 1080 x 1920, 1280 x 720, 720 x 1280, 3840 x 2160, and 2160 x 3840. 4K is available only when the virtual avatar model supports 4K.

  • When clip_mode is set to CROP, (dx, dy) is the origin, and the width is the actual width of the reserved video.

  • Currently, only 1080 x 1920 is supported for virtual avatar livestreaming.

Value range:

0~3840

height

Integer

Video height.

Unit: pixel

The value ranges from 320 to 2560.

NOTE:

  • When clip_mode is set to RESIZE, the following resolutions are supported: 1920 x 1080, 1080 x 1920, 1280 x 720, 720 x 1280, 3840 x 2160, and 2160 x 3840.

  • When clip_mode is set to CROP, (dx, dy) is the origin, and the height is the actual height of the reserved video.

  • Currently, only 1080 x 1920 is supported for virtual avatar livestreaming.

Value range:

0~3840
Table 10 SmartChatVoiceConfig

Parameter

Type

Description

voice_asset_id

String

Speech synthesis feature string

speed

Integer

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

The value 100 indicates the normal speaking speed of an adult, which is about 250 words per minute.

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

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/smart-chat-rooms/41c86xxxxxx34253850af102cdxxxxxx/smart-chat-jobs

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "count" : 1,
  "smart_chat_jobs" : [ {
    "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
    "state" : "WAITING",
    "start_time" : "2022-01-18T16:29:36Z",
    "end_time" : "2022-01-18T16:30:36Z",
    "duration" : 60
  } ]
}

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

Parent Topic: Virtual Avatar Dialog Task Management