1. 接口描述
接口请求域名： mps.tencentcloudapi.com 。
智能字幕新建热词库接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateAsrHotwords。 |
| Version | 是 | String | 公共参数，本接口取值：2019-06-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Type | 是 | Integer | 0 临时热词 1 文件热词 示例值：0 |
| Name | 是 | String | 热词库名称 示例值：HotwordsName |
| Content | 否 | String | 热词库文本，Type为 0 必选 示例值：腾讯云|10,语音识别|5,ASR|10 |
| FileContent | 否 | String | 热词库文件的 base64 的内容，Type 为 1 必选 示例值：data:text/plain;base64,5a123test4566= |
| FileName | 否 | String | 上传的文件名 示例值：example.txt |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| HotwordsId | String | 热词库 id 示例值：hwd-aexxxxxxxxxxxxxx1481 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 CreateAsrHotwordsExample
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAsrHotwords
<公共请求参数>
{
"Type": 0,
"Name": "HotwordsNameExample",
"Content": "腾讯云|10,语音识别|5,ASR|10"
}输出示例
{
"Response": {
"HotwordsId": "hwd-aexxxxxxxxxxxxxx1481",
"RequestId": "1ebaa15b-14b5-480c-9904-ec90c536e701"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.AccessDBError | 数据错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.HotwordsFormatError | 热词库格式错误。请参考热词配置说明文档。 |
| InvalidParameterValue.InputInfo | 输入参数有误 |
| LimitExceeded.TooMuchHotWords | 热词库创建数量到达默认上限 |
| LimitExceeded.TooMuchLargeHotWords | 大型热词库创建到达上限 |
