Help Center/ MetaStudio/ API Reference/ TTS/ Tenant-Level TTS Configuration Management/ Obtaining a Tenant-Level Custom Pronunciation for TTS
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining a Tenant-Level Custom Pronunciation for TTS

Function

Obtains a tenant-level custom pronunciation for TTS.

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}/ttsc/vocabulary-configs

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

Parameter

Mandatory

Type

Description

type

No

String

Custom pronunciation type.

  • CHINESE_G2P: pinyin

  • PHONETIC_SYMBOL: phonetic symbol

  • CONTINUUM: continuous reading

  • ALIAS: alias

  • SAY_AS: Pronunciations of digits

tts_service_name

No

String

Voice model name

is_vocabulary_config_enable

No

String

Whether to apply the word list configuration, which is transferred from related services.

group_id

No

String

Group ID.

asset_id

No

String

Asset ID.

limit

No

Integer

Number of items displayed on each page.

Value range:

1~100

Default value:

10

offset

No

Integer

Offset where the query starts.

Value range:

0~2147483647

Default value:

0

start_time

No

String

Start time. 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.

search_key

No

String

Search criteria.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Request-Id

No

String

Request ID, which identifies the request of one stream and is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

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 body parameters

Parameter

Type

Description

count

Integer

Total number of records.

Value range:

0~2147483647

data

Array of VocabularyConfig objects

Custom pronunciation.
Table 5 VocabularyConfig

Parameter

Type

Description

id

String

id

key

String

Original word.

value

String

Custom pronunciation.

type

String

Word list types supported by TTSS.

  • CHINESE_G2P: pinyin

  • PHONETIC_SYMBOL: phonetic symbol

  • CONTINUUM: continuous reading

  • ALIAS: alias

  • SAY_AS: pronunciations of digits

group_id

String

Group ID.

create_time

String

Creation time.

update_time

String

Update time.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Return code.

  • MSS.000000001: failure

  • MSS.000000002: internal error

  • MSS.000000003: invalid parameter

  • MSS.000000004: invalid access. The access is not authenticated or fails to be authenticated.

error_msg

String

Return result description

request_id

String

Unique ID of the request.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Return code.

  • MSS.000000001: failure

  • MSS.000000002: internal error

  • MSS.000000003: invalid parameter

  • MSS.000000004: invalid access. The access is not authenticated or fails to be authenticated.

error_msg

String

Return result description

request_id

String

Unique ID of the request.

Example Requests

GET https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs?type=CHINESE_G2P

Example Responses

Status code: 200

Succeeded.

{
  "count" : 1,
  "data" : [ {
    "id" : "90247b5e90247b5e90247b5e11111111",
    "key" : "Tong Xing",
    "value" : "tong2 xing2"
  } ]
}

Status Codes

Status Code

Description

200

Succeeded.

400

Parameter error.

500

Server error.

Error Codes

See Error Codes.

Parent Topic: Tenant-Level TTS Configuration Management