DescribeAsrHotwordsList

Last updated: 2025-03-28 15:37:13Download PDF

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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	Paging offset. Default value: 0.
Limit	No	Integer	Number of returned entries. All hotword lexicons are returned by default.
OrderType	No	Integer	Hotword lexicon sorting order. 0: ascending (default) 1: descending
OrderBy	No	String	Sorts hotword lexicons by a specific field. By default, hotword lexicons are sorted by creation time. If an invalid field is used for sorting, the default sorting field applies. - CreateTime: sort by creation time - UpdateTime: sort by update time - 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.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of hotword lexicons.
Offset	Integer	Paging 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.

4. Example

Example1 DescribeAsrHotwordsList

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAsrHotwordsList
<Common request parameters>

{
    "HotwordsId": "hwd-aexxxxxxxxxxxxxx1481"
}

Output Example

{
    "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
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.