简介
本文档提供关于音频审核的 API 概览和 SDK 示例代码。
API | 操作描述 |
用于提交一个音频审核任务 | |
用于查询指定的音频审核任务 |
提交音频审核任务
功能说明
用于提交一个音频审核任务。
方法原型
AudioAuditingResponse createAudioAuditingJob(AudioAuditingRequest request);
请求示例
//1.创建任务请求对象AudioAuditingRequest request = new AudioAuditingRequest();//2.添加请求参数 参数详情请见api接口文档request.setBucketName("examplebucket-1250000000");request.getInput().setObject("pron.mp3");request.getConf().setDetectType("Porn,Ads");request.getConf().setCallback("http://cloud.tencent.com/");//3.调用接口,获取任务响应对象AudioAuditingResponse response = client.createAudioAuditingJobs(request);
参数说明
Request 中的具体数据描述如下：
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Input | Request | 需要审核的内容。 | Container | 是 |
Conf | Request | 审核规则配置。 | Container | 是 |
Container 类型 Input 的具体数据描述如下：
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 存储在 COS 存储桶中的音频文件名称，例如在目录 test 中的文件audio.mp3，则文件名称为 test/audio.mp3。Object 和 Url 只能选择其中一种。 | String | 否 |
Url | Request.Input | 音频文件的链接地址，例如 http://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/audio.mp3。Object 和 Url 只能选择其中一种。 | String | 否 |
Container 类型 Conf 的具体数据描述如下：
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
BizType | Request.Conf | String | 否 | |
DetectType | Request.Conf | （后续不再维护）审核的场景类型，有效值：Porn（涉黄）、Ads（广告）等，可以传入多种类型，不同类型以逗号分隔，例如：Porn,Ads。如您有更多场景的审核需要，请使用 BizType 参数。 | String | 否 |
Callback | Request.Conf | 审核结果以回调形式发送至您的回调地址，支持以 http:// 或者 https:// 开头的地址，例如：http://www.callback.com。 | String | 否 |
CallbackVersion | Request.Conf | 回调内容的结构，有效值：Simple（回调内容包含基本信息）、Detail（回调内容包含详细信息）。默认为 Simple。 | string | 否 |
返回结果说明
成功：成功则返回 AudioAuditingResponse 音频审核任务结果对象。
失败：发生错误（例如 Bucket 不存在），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。
查询音频审核任务
功能说明
用于查询音频审核任务执行情况和结果。
方法原型
AudioAuditingResponse describeAuditingJob(AudioAuditingRequest request);
请求示例
//1.创建任务请求对象AudioAuditingRequest request = new AudioAuditingRequest();//2.添加请求参数 参数详情请见api接口文档request.setBucketName("examplebucket-1250000000");request.setJobId("sacbf7269cbd2e11eba5325254009*****");//3.调用接口,获取任务响应对象AudioAuditingResponse response = client.describeAudioAuditingJob(request);
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
bucketName | Bucket 的命名规则为 BucketName-APPID，详情请参见 存储桶概述 | String | 是 |
jobId | 需要查询的任务 ID | String | 是 |
返回结果说明
成功： 返回 AudioAuditingResponse 审核任务结果对象，字段含义请参见 查询音频审核任务结果。
失败： 发生错误（例如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。
