1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
获取热词库列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAsrHotwordsList。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
HotwordsId | 否 | String | 检索参数,根据热词库 id 查询 示例值:hwd-aexxxxxxxxxxx1481 |
Name | 否 | String | 检索参数,根据热词库名称查询 示例值:Hotwords |
Offset | 否 | Integer | 分页偏移量,默认值:0。 示例值:0 |
Limit | 否 | Integer | 返回记录条数,默认返回所有热词库 示例值:10 |
OrderType | 否 | Integer | 热词排序顺序 0:升序(默认) 1:降序 示例值:0 |
OrderBy | 否 | String | 根据某个字段排序,默认使用创建时间,使用非法字段视为默认情况 - CreateTime:创建时间排序 - UpdateTime:更新时间排序 - Name:热词库名称排序 - WordCount:热词数量排序 - HotwordsId:热词库 id 排序 示例值:CreateTime |
Types.N | 否 | Array of Integer | 0 临时热词 1 文件热词 示例值:[0,1] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总热词库数量 示例值:100 |
Offset | Integer | 分页偏移量,默认值:0。 示例值:0 |
Limit | Integer | 返回记录条数,默认返回所有热词库 示例值:10 |
AsrHotwordsSet | Array of AsrHotwordsSet | 热词库列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeAsrHotwordsList
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAsrHotwordsList
<公共请求参数>
{
"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
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数取值错误。 |