1. 接口描述
接口请求域名: vm.tencentcloudapi.com 。
本接口(Video Moderation System,VM)用于提交视频文件或视频流进行智能审核任务。使用前请您使用腾讯云主账号登录控制台开通视频内容安全服务并调整好对应的业务配置。
功能使用说明:
前往“内容安全控制台-视频内容安全”开启使用视频内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含200分钟的处理量(换算1s每帧截图,赠送12000张图、200分钟的音频处理量),有效期为15天。
该接口为收费接口,计费方式敬请参见腾讯云视频内容安全定价。
默认接口请求频率限制:20次/秒,对于异步审核任务(点播视频),超出频率限制的请求会自动排入待审核队列,对于同步审核任务(直播视频),超出频率限制将会报错。
默认并发审核路数限制:点播默认10路,异步审核任务(点播视频)数量超过并发审核路数时,将会进入排队;直播默认100路,同步审核任务(直播视频)超过并发审核路数,接口会返回错误。
接口功能说明:
- 支持对视频文件或视频流进行自动检测,从 OCR文本识别、物体检测(实体、广告台标、二维码等)、图像识别及音频审核四个维度,通过深度学习技术识别视频中的违规内容;
- 支持设置回调地址 Callback 获取检测结果,或通过接口(查看任务详情)主动轮询获取检测结果详情;对于正常审核中的视频任务,如含有违规内容,则截帧图片最长会在3s内回调,音频片段会在用户配置的切片时长 + 2s内回调;对于在队列中的待审核任务,回调时间为正常审核回调时间+等待时间;
- 支持通过接口(查看审核任务列表)查询任务队列,用户可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表;
- 支持识别多种违规场景,包括:低俗、谩骂、色情、广告等场景;
- 支持根据不同的业务场景配置自定义的审核策略;
- 支持用户自定义配置黑白词库及图片库,打击自定义违规内容(目前仅支持黑名单配置);
- 支持用户自定义配置审核任务优先级,当有多个任务排队时,可根据用户配置自动调整任务优先级;
- 支持批量提交检测任务,最多可同时创建10个任务;
视频文件调用说明:
- 视频文件大小支持:4K视频文件 < 10GB;低于4K视频文件 < 5GB
- 视频文件分辨率支持:最佳分辨率为1920x1080 (1080p),如果视频文件小于300MB,则分辨率可以大于1080p,分辨率最大支持4K,更大视频可以调用云转码服务转码后再送审;
- 视频文件支持格式:flv、mkv 、mp4 、rmvb 、avi 、wmv、3gp、ts、mov、rm、mpeg、wmf等。
- 视频文件支持的访问方式:链接地址(支持HTTP/HTTPS)、腾讯云COS存储;
- 若传入视频文件的访问链接,则需要注意视频头文件的读取时间限制为3秒,为保障被检测视频的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;
- 支持用户配置是否需要开启音频审核,若不开启则将仅对视频文件图像内容进行审核。
视频流调用说明:
- 视频流时长支持:8小时以内
- 视频流分辨率支持:支持1920x1080 (1080p),更高分辨率视频可以调用直播云转码服务转码后再送审;
- 视频流支持格式:rmtp,flv 等主流视频流编码格式。
- 视频流支持的传输协议:HTTP/HTTPS/RTMP;
- 支持用户配置是否需要开启音频审核,若不开启则将仅对视频流图像内容进行审核。
直播断流处理说明:
- 请确认已对接取消任务。
- 如果直播任务取消/结束,则终止直播拉流并退出审核。
- 如果直播任务没有取消/结束,直播视频推流因故中断,产品将在将在10分钟内持续拉流重试。如果10分钟检测到图片截帧/音频切片数据,则恢复正常审核,反之,则终止拉流并退出审核。在拉流终止后,用户如有审核需求,需重新送审。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateVideoModerationTask。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
BizType | 是 | String | 该字段表示特定审核策略的编号,用于接口调度。需要提前在内容安全控制台中创建策略后获取该Biztype字段,传入该字段,会根据业务场景在审核时调用相应的审核策略。 备注:Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype。 示例值:1001 |
Type | 是 | String | 任务类型:可选VIDEO(点播视频),LIVE_VIDEO(直播视频) 示例值:VIDEO |
Tasks.N | 是 | Array of TaskInput | 输入的任务信息,最多可以同时创建10个任务 |
Seed | 否 | String | 验证签名参数,具体可以参考验签说明。 示例值:sfsfsderwerwe |
CallbackUrl | 否 | String | 接收审核信息回调地址。如果设置了该字段,在审核过程中发现违规音频片段和画面截帧结果将发送至该接口。更多详情请参阅回调配置说明。 示例值:http://192.0.0.1:8080 |
Priority | 否 | Integer | 审核排队优先级。当您有多个视频审核任务排队时,可以根据这个参数控制排队优先级。用于处理插队等逻辑。默认该参数为0 示例值:10 |
User | 否 | User | 该字段表示待检测对象对应的用户相关信息,若填入则可甄别相应违规风险用户 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Results | Array of TaskResult | 任务创建结果 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建视频审核任务
创建视频审核任务
输入示例
POST / HTTP/1.1
Host: vm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoModerationTask
<公共请求参数>
{
"BizType": "1001",
"Tasks": [
{
"DataId": "test_data_1",
"Input": {
"Url": "https://v.com/test.mp4",
"Type": "URL"
}
}
],
"Type": "VIDEO"
}
输出示例
{
"Response": {
"Results": [
{
"DataId": "0a782332-c9db-4cf5-a66e-20d60b4ea469",
"TaskId": "c933aca1-90d2-4ab8-b045-f1b08069d76f",
"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 | 操作不支持。 |