1. 接口描述
接口请求域名: ams.tencentcloudapi.com 。
本接口(Audio Moderation)用于提交音频内容(包括音频文件或流地址)进行智能审核任务,使用前请您使用腾讯云主账号登录控制台开通音频内容安全服务并调整好对应的业务配置。
功能使用说明:
- 前往“内容安全控制台-音频内容安全”开启使用音频内容安全服务,首次开通可获得10小时免费调用时长,有效期为1个月。
审核并发限制说明:
- 点播音频(异步审核)
- 默认并发路数:10
- 队列处理机制:
- 当并发任务达到上限时,新任务进入队列等待处理;
- 新送审任务优先处理,旧任务往后排;
- 直播音频(异步审核)
- 默认并发路数:100
- 队列处理机制:
- 运行中的审核任务达到上限时,新请求会提示超频错误:
RequestLimitExceeded
,错误详细为:You have reached the concurrency limit
; - 不支持排队;
- 运行中的审核任务达到上限时,新请求会提示超频错误:
接口功能说明:
- 支持对音频流或音频文件进行检测,判断其中是否包含违规内容;
- 支持设置回调地址 Callback 获取检测结果(对于已在审核的任务,最长回调时间为用户配置的切片时长 + 2s),或通过接口(查询音频检测结果)主动轮询获取检测结果;
- 支持识别违规内容,包括:低俗、谩骂、色情、广告等场景;
- 支持批量提交检测任务,检测任务列表最多支持10个。
音频文件流调用说明:
- 音频文件大小支持:文件 < 500M;
- 音频文件时长支持:< 1小时;
- 音频码率类型支持:128 Kbps - 256 Kbps ;
- 音频文件支持格式:wav、mp3、aac、flac、amr、3gp、 m4a、wma、ogg、ape;
- (当输入为视频文件时)支持分离视频文件音轨,并对音频内容进行独立审核。
直播音频流调用说明:
- 音频流时长支持:24小时以内,超过需要重新推送审核任务;
- 音频码率类型支持:128 Kbps - 256 Kbps ;
- 音频流支持的传输协议:RTMP、HTTP、HTTPS;
- 音频流格式支持的类型:rtp、srtp、rtmp、rtmps、mmsh、 mmst、hls、http、tcp、https、m3u8;
- (当输入为视频流时)支持提取视频流音轨,并对音频内容进行独立审核。
直播断流处理说明:
- 请确认已对接取消任务。
- 如果直播任务取消/结束,则终止直播拉流并退出审核。
- 在直播任务未取消或结束的情况下,若推流中断(例如
Operation not permitted
错误),审核服务将在 10分钟内持续尝试重新拉流。检测到有效的图片或音频数据,审核将自动恢复正常;否则,10分钟后终止拉流并退出审核。此时如有需要,请重新提交审核请求。对于因网络问题导致的拉流失败(如HTTP 404 Not Found
错误),系统将进行最多 16次重试。若成功获取有效数据,审核流程即刻恢复;若所有重试均失败,则同样终止拉流并退出审核,需用户重新送审。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAudioModerationTask。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Tasks.N | 是 | Array of TaskInput | 该字段表示输入的音频审核任务信息,具体输入内容请参见TaskInput数据结构的详细描述。 备注:最多同时可创建10个任务。 |
BizType | 否 | String | 该字段表示使用的策略的具体编号,该字段需要先在内容安全控制台中配置。 备注:不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype。 示例值:default |
Type | 否 | String | 该字段表示输入的音频审核类型,取值含:AUDIO(点播音频)、LIVE_AUDIO(直播音频)、AUDIO_AIGC(AI生成识别)三种,默认值为AUDIO。 示例值:AUDIO |
Seed | 否 | String | 可选参数,该字段表示回调签名的key信息,用于保证数据的安全性。 签名方法为在返回的HTTP头部添加 X-Signature 的字段,值为: seed + body 的 SHA256 编码和Hex字符串,在收到回调数据后,可以根据返回的body,用 sha256(seed + body), 计算出 X-Signature 进行验证。具体使用实例可参考 回调签名示例。 示例值:askseed |
CallbackUrl | 否 | String | 接收审核信息回调地址。如果设置了该字段,在审核过程中发现违规音频片段结果将发送至该接口。更多详情请参阅回调配置说明。 示例值:https://example.com/url |
User | 否 | User | 该字段表示待检测对象对应的用户相关信息,若填入则可甄别相应违规风险用户 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Results | Array of TaskResult | 该字段用于返回任务创建的结果,具体输出内容请参见TaskResult数据结构的详细描述。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建音频审核任务
创建音频审核任务
输入示例
POST / HTTP/1.1
Host: ams.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAudioModerationTask
<公共请求参数>
{
"BizType": "default",
"Type": "AUDIO",
"Tasks": [
{
"DataId": "0a782332-c9db-4cf5-a66e-20d60b4ea469",
"Input": {
"Type": "URL",
"Url": "https://test.myqcloud.com/test.mp3"
}
}
]
}
输出示例
{
"Response": {
"Results": [
{
"DataId": "0a782332-c9db-4cf5-a66e-20d60b4ea469",
"TaskId": "w-audio-aqwfdNiA4vq3Zysfa1",
"Code": "OK",
"Message": "Success"
}
],
"RequestId": "c933aca1-90d2-4ab8-b045-f1b08069d76f"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |