Help Center/ Speech Interaction Service/ API Reference/ Hot Word Management APIs/ Querying Hot Word Tables
Updated on 2025-08-26 GMT+08:00
View PDF
Share

Querying Hot Word Tables

Function

This API is used to query all hot word tables of a user.

URI

GET /v1/{project_id}/asr/vocabularies

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It is used to obtain the permission to call APIs. For details about how to obtain a user token, see Authentication. The token is the value of X-Subject-Token in the response header.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Name of a hot word table, used for filtering hot word tables.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Mandatory

Type

Description

count

Yes

Integer

Number of hot word tables.

result

Yes

Array of VocabInfo objects

If the calling is successful, hot word tables are returned. Otherwise, this parameter is invalid.
Table 5 VocabInfo

Parameter

Mandatory

Type

Description

vocabulary_id

Yes

String

Hot word ID

name

Yes

String

Name of a hot word table

language

Yes

String

Language type of the hot word table

description

Yes

String

Description of a hot word table

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned when the API fails to be called. This parameter is not included when the API is successfully called.

error_msg

String

Error message returned when the API fails to be called. This parameter is not included when the API is successfully called.

Example Requests

The endpoint is the request URL for calling an API. Endpoints vary according to services and regions. For details, see Endpoints.

  • Obtain the hot word table list. 
    GET https://{endpoint}/v1/{project_id}/asr/vocabularies

Request header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

Example Responses

Status code: 200

Example response (successful request)

{ 
  "result": [
    {
        "vocabulary_id": "5F85A74C-BED9-4a15-B66E-039251D877D6",
        "language": "chinese_mandarin", 
        "name": "weather",
        "description": "no desc"
    },
    {
        "vocabulary_id": "50875954-7328-42ab-B236-B3EC6E22207A",
        "language": "chinese_mandarin", 
        "name": "war",
        "description": "no desc"
    }
  ]
}

Status code: 400

Failure response example

{ 
    "error_code":"SIS.0201", 
    "error_msg":"***" 
}

Status Code

For details about status codes, see Status Codes.

Error Code

For details about error codes, see Error Codes.

Parent topic: Hot Word Management APIs