1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
返回当前用户的审核模板列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAuditTemplates。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| WithTextAudit | 否 | Boolean | 是否过滤出文本审核,false不过滤,true过滤。 示例值:true |
| PageNum | 否 | Integer | 页码。 示例值:2 |
| PageSize | 否 | Integer | 每页数量。 取值范围:[5, 100] 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AuditTemplates | Array of AuditTemplate | 审核模板列表。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeAuditTemplates
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditTemplates
<公共请求参数>
{
"WithTextAudit": false,
"PageNum": 1,
"PageSize": 10
}
输出示例
{
"Response": {
"AuditTemplates": [
{
"AudioInterval": 15,
"AuditAudio": false,
"AuditImage": true,
"AuditText": 0,
"CosBucket": "2",
"CosFilePath": "/Audit/{Year}-{Month}-{Day}/{StreamID}-Audit-{Hour}-{Minute}-{Second}{Ext}",
"CosRegion": "ap-guangzhou",
"Description": "",
"EnableFailoverCos": false,
"FailoverCosBucket": "",
"FailoverCosRegion": "",
"SceneInfos": [
{
"BizInfos": [
{
"BizType": "1_1_7_8390211",
"Status": true,
"StrategyConfig": "{\"ability\":{\"asr_text\":true,\"audio\":true},\"service_config\":{\"callback_info\":{},\"codec_info\":{}},\"ignore_word_conf\":{\"model_disable\":false,\"rule_disable\":false,\"keyword_disable\":false},\"user_text_libs\":[]}",
"StrategyType": "ShortAudio"
}
],
"SceneID": "LiveAudit"
}
],
"SnapshotInterval": 2,
"TemplateId": 8390211,
"TemplateName": "qwe"
}
],
"RequestId": "23171f70-25d8-4c72-9342-51439526af6d"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |