Listing Tenant-Level Word List Groups for TTS

Function

Lists tenant-level word list groups 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-groups

**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
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
group_id	No	String	Group ID.

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 TtscGroupAssetsConfig objects	List of customized word list groups.

**Table 5** TtscGroupAssetsConfig
Parameter	Type	Description
group_id	String	Group ID.
group_name	String	Group name.
asset_ids	Array of strings	List of asset IDs in each group.

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-groups

Example Responses

Status code: 200

Succeeded.

{
  "count" : 1,
  "data" : [ {
    "group_id" : "90247b5e90247b5e90247b5e11111111",
    "group_name" : "Word list name.",
    "asset_ids" : [ "7b5e90247b5e90247b5e902422222222" ]
  } ]
}