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

Modifying a Tenant-Level Custom Pronunciation for TTS

Function

Modifies 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

PUT /v1/{project_id}/ttsc/vocabulary-configs/{vocabulary_id}

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.

vocabulary_id

Yes

String

Custom pronunciation ID.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Supported custom pronunciation type. The current pronunciation type will be mapped to an SSML tag. For details, see Text-Controlled SSML Definition.

Options:

  • CHINESE_G2P: pinyin

  • PHONETIC_SYMBOL: phonetic symbol

  • CONTINUUM: continuous reading

  • ALIAS: alias

  • SAY_AS: pronunciations of digits and letters. Different values indicate different pronunciations:

    • date: date

    • number: number

    • figure: value

    • telephone: phone number

    Pronunciations of letters:

    • spell: letter

    • english: word

Pronunciations of digits:

key

No

String

Original word.

Default value:

N/A

value

No

String

Custom pronunciation. For the pronunciations of phonetic symbols, see Dictionary.

Default value:

N/A

group_id

No

String

Group ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Configuration item ID.

Status code: 400

Table 5 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 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.

Example Requests

PUT https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs/2c90849a9406d9ee0194072e0b1c0002

{
  "type" : "CHINESE_G2P",
  "key" : "Tong Xing",
  "value" : "tong2 xing2"
}

Example Responses

Status code: 200

Succeeded.

{
  "id" : "efc5300ecdba4ea48d1ff13a9d907bc0"
}

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