Querying Interactive Dialogs

project_id

Yes

String

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

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

room_name

No

String

Fuzzy query by interactive dialog name.

model_name

No

String

Fuzzy search by image name.

start_time

No

String

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

end_time

No

String

End time. The format complies with RFC 3339, for example, 2021-01-10T10:43:17Z.

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.

count

Integer

Details:

Total number of interactive dialogs.

Value range:

0~2147483647

count_concurrency

Integer

Details:

Total number of concurrent interactive dialogs.

Value range:

0~1024000

count_client_nums

Integer

Definition:

Total number of interactive dialogs billed by access terminal.

Value range:

0~1024000

count_client_nums_token

Integer

Definition:

Total number of interactive dialogs billed by access terminal (tokens).

Value range:

0~1024000

smart_chat_rooms

Array of SmartChatRoomBaseInfo objects

Interactive dialogs.

room_id

String

Interactive dialog ID

room_name

String

Interactive dialog name

room_description

String

Description of an interactive dialog.

robot_id

String

Bot ID.

cover_url

String

Dialog thumbnail URL

model_infos

ModelInfo object

Virtual human model information.

voice_config

VoiceConfig object

Voice parameter settings.

billing_mode

String

Billing mode. The default value is CONCURRENCY.

• CONCURRENCY: concurrent billing

• CLIENT: billed by access end

• CLIENT_TOKENS: billed by access end (tokens)

reuse_resource

Boolean

Indicates whether to allow the use of unallocated concurrent quota (cannot be reused in device mode). By default, the unallocated concurrent quota is not used.

concurrency

Integer

Details:

Maximum concurrent dialogs.

Value range:

0~1024

client_nums

Integer

Definition:

Number of allowed access terminals.

Value range:

0~1024

voice_config_list

Array of VoiceConfigRsp objects

Voice configuration parameter list.

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

create_time

String

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

update_time

String

Update time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

exit_mute_threshold

Integer

Definition:

Inactivity timeout after which a dialog automatically closes.

Value range:

0~1440

model_asset_id

String

Model asset ID, which can be queried from the asset library.

asset_name

String

Asset name.

backup_model_asset_ids

Array of strings

ID of the alternative virtual streamer asset (image asset only) during streamer rotation, which can be queried from the asset library.

voice_asset_id

String

Definition

Timbre asset ID, which can be queried from the asset library.

For details about how to query voice IDs, see Querying Preset Voice IDs.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

speed

Integer

Definition

Speaking speed. 50 indicates 0.5x speaking speed, 100 indicates normal speaking speed, and 200 indicates 2x speaking speed.

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

Constraints

N/A

Value range:

50~200

Default value:

100

pitch

Integer

Definition

Pitch.

Constraints

N/A

Value range:

50~200

Default value:

100

volume

Integer

Definition

Volume.

Constraints

N/A

Value range:

90~240

Default value:

140

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.

200

Succeeded.

400

Parameters error, including the error code and its description.

401

Authentication is not performed or fails.

500

Internal service error.