Help Center/ MetaStudio/ API Reference/ TTS/ TTS Management/ Obtaining an English Phonetic Symbol
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining an English Phonetic Symbol

Function

Obtains the phonetic symbol of an English word.

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/phonetic-symbol

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

offset

No

Integer

Query offset. If the value exceeds the maximum number of records available, records on the last page are returned.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Number of queried records.

Value range:

1~1000

Default value:

10

word

Yes

String

English word.

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

data

Array of strings

Phonetic list

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

GET https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/phonetic-symbol?word=MATER

Example Responses

Status code: 200

Succeeded.

{
  "data" : [ "ˈmɑːtə(r)", "ˈmætə(r)", "ˈmeɪtə(r)" ]
}

Status Codes

Status Code

Description

200

Succeeded.

400

Parameter error.

500

Server error.

Error Codes

See Error Codes.

Parent Topic: TTS Management