Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to obtain the hotword lexicon list.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeAsrHotwordsList. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| HotwordsId | No | String | Parameter for querying by hotword lexicon ID. |
| Name | No | String | Parameter for querying by hotword lexicon name. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. All hotword lexicons are returned by default. |
| OrderType | No | Integer | Hotword lexicon sort order 0: ascending (default) 1: descending |
| OrderBy | No | String | Sorts by a certain field. By default, sorts by creation time. Using an illegal field is deemed as the default. - CreateTime: sort by creation time -UpdateTime: Update time sorting -Name: Sort by hotword lexicon name. - WordCount: sort by the number of hotwords - HotwordsId: sort by hotword lexicon ID |
| Types.N | No | Array of Integer | 0: temporary hotword; 1 file-based hotword. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of hotword lexicons. |
| Offset | Integer | Pagination offset. Default value: 0. |
| Limit | Integer | Number of returned entries. All hotword lexicons are returned by default. |
| AsrHotwordsSet | Array of AsrHotwordsSet | Hotword lexicon list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAsrHotwordsList
<Common request parameters>
{
"HotwordsId": "hwd-aexxxxxxxxxxxxxx1481"
}{
"Response": {
"AsrHotwordsSet": [
{
"CreateTime": "2025-03-19T03:29:06Z",
"FileName": "",
"HotwordsId": "hwd-aexxxxxxxxxxxxxx1481",
"Name": "HotwordsNameExample",
"Status": 0,
"Type": 0,
"UpdateTime": "2025-03-19T03:29:06Z",
"WordCount": 3
}
],
"Limit": 0,
"Offset": 0,
"RequestId": "0beec64c-8390-43dd-8b3a-14df16cc9ca7",
"TotalCount": 1
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Incorrect parameter value. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários