1. 接口描述
接口请求域名: asr.tencentcloudapi.com 。
用户通过该接口,可获得所有的关键词表及其信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetAsrKeyWordLibList。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-14。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 否 | Integer | 分页Offset |
Limit | 否 | Integer | 分页Limit |
SpecifyNames.N | 否 | Array of String | 词库名称或者UIN检索 |
OnlySelf | 否 | Boolean | 只看用户自己创建的 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | KeyWordLibListData | 关键词列表返回数据 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列举关键词表
用户通过该接口,可获得所有的关键词表及其信息。
输入示例
https://asr.tencentcloudapi.com/?Action=GetAsrKeyWordLibList
&<公共请求参数>
输出示例
{
"Response": {
"Data": {
"KeyWordLibList": [
{
"KeyWordLibId": "aa6f402f263f12ea856fc81fbecfd0sd",
"Name": "示例词表",
"KeyWordList": [
"避风港"
],
"CreateTime": "2024-08-24T13:28:48+00:00",
"UpdateTime": "2024-08-24T13:28:48+00:00"
}
],
"TotalCount": 1
},
"RequestId": "b3808ad3-d8dd-4b65-96c9-7d6f1f81b6b6"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.CheckResourceResponseCodeError | 用户没有权限进行此查询操作。 |
AuthFailure.UnauthorizedOperation | 未授权操作。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.FailAccessDatabase | 访问数据库失败。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |