{
  "name": "vm",
  "display_name": "视频内容安全",
  "description": "介绍如何使用API对点播、直播视频内容检测进行操作，包括识别点播、直播视频中的不适宜内容等。",
  "domain": "other",
  "api_version": "2021-09-22",
  "endpoint": "vm.tencentcloudapi.com",
  "actions": [
    {
      "name": "CancelTask",
      "description": "可使用该接口取消审核任务，成功取消后，该接口返回已取消任务的TaskId。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务ID",
          "example": "w-video-aDKaIiA4vq3ZaAA1"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "CreateVideoModerationTask",
      "description": "本接口（Video Moderation System，VM）用于提交视频文件或视频流进行智能审核任务。使用前请您使用腾讯云主账号登录控制台[开通视频内容安全服务](https://console.cloud.tencent.com/cms)并调整好对应的业务配置。 ### 功能使用说明： - 前往“[内容安全控制台-视频内容安全](https://console.cloud.tencent.com/cms)”开启使用视频内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含200分...",
      "status": "online",
      "parameters": [
        {
          "name": "BizType",
          "type": "string",
          "required": true,
          "description": "该字段表示特定审核策略的编号，用于接口调度。需要提前在[内容安全控制台](https://console.cloud.tencent.com/cms/clouds/manage)中创建策略后获取该Biztype字段，传入该字段，会根据业务场景在审核时调用相应的审核策略。 备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype。",
          "example": "1001"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "任务类型：可选VIDEO（点播视频），LIVE_VIDEO（直播视频），VIDEO_AIGC（AI生成检测）",
          "example": "VIDEO"
        },
        {
          "name": "Tasks",
          "type": "array",
          "required": true,
          "description": "输入的任务信息，最多可以同时创建10个任务",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "DataId",
              "type": "string",
              "required": false,
              "description": "数据ID",
              "example": "080cbccd-4d19-4792-b2cb-28dc52d108e4"
            },
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "任务名",
              "example": "cmsop"
            },
            {
              "name": "Input",
              "type": "object",
              "required": false,
              "description": "任务输入",
              "example": "无",
              "children": [
                {
                  "name": "Type",
                  "type": "string",
                  "required": false,
                  "description": "类型 可选： URL 资源链接类型 COS 腾讯云对象存储类型",
                  "example": "URL"
                },
                {
                  "name": "Url",
                  "type": "string",
                  "required": false,
                  "description": "资源链接",
                  "example": "https://cmstest-123.cos.ap-guangzhou.myqcloud.com/audio.mp4"
                },
                {
                  "name": "BucketInfo",
                  "type": "object",
                  "required": false,
                  "description": "腾讯云存储桶信息",
                  "example": "无",
                  "children": [
                    {
                      "name": "Bucket",
                      "type": "string",
                      "required": true,
                      "description": "腾讯云对象存储，存储桶名称",
                      "example": "cmsop-appid"
                    },
                    {
                      "name": "Region",
                      "type": "string",
                      "required": true,
                      "description": "地域",
                      "example": "ap-guangzhou"
                    },
                    {
                      "name": "Object",
                      "type": "string",
                      "required": true,
                      "description": "对象Key",
                      "example": "/audioDate/20240101/cmsop-audio.mp4"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "Seed",
          "type": "string",
          "required": false,
          "description": "可选参数，该字段表示回调签名的key信息，用于保证数据的安全性。 签名方法为在返回的HTTP头部添加 X-Signature 的字段，值为： seed + body 的 SHA256 编码和Hex字符串，在收到回调数据后，可以根据返回的body，用 **sha256(seed + body)**, 计算出 `X-Signature` 进行验证。具体使用实例可参考 [回调签名示例](https://cloud.tencent.com/document/product/1265/104001#42dd87d2-580f-46cf-a953-639a787d1eda)。",
          "example": "sfsfsderwerwe"
        },
        {
          "name": "CallbackUrl",
          "type": "string",
          "required": false,
          "description": "接收审核信息回调地址。如果设置了该字段，在审核过程中发现违规音频片段和画面截帧结果将发送至该接口。更多详情请参阅[回调配置说明](https://cloud.tencent.com/document/product/1265/104001)。",
          "example": "https://example.com/url"
        },
        {
          "name": "Priority",
          "type": "integer",
          "required": false,
          "description": "审核排队优先级。当您有多个视频审核任务排队时，可以根据这个参数控制排队优先级。用于处理插队等逻辑。默认该参数为0",
          "example": "10"
        },
        {
          "name": "User",
          "type": "object",
          "required": false,
          "description": "该字段表示待检测对象对应的用户相关信息，若填入则可甄别相应违规风险用户",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "业务用户ID 如填写，会根据账号历史恶意情况，判定消息有害结果，特别是有利于可疑恶意情况下的辅助判断。账号可以填写微信uin、QQ号、微信openid、QQopenid、字符串等。该字段和账号类别确定唯一账号。",
              "example": "user1"
            },
            {
              "name": "AccountType",
              "type": "string",
              "required": false,
              "description": "该字段表示业务用户ID对应的账号类型，取值：1-微信uin，2-QQ号，3-微信群uin，4-qq群号，5-微信openid，6-QQopenid，7-其它string。 该字段与账号ID参数（UserId）配合使用可确定唯一账号。",
              "example": "172300"
            },
            {
              "name": "Nickname",
              "type": "string",
              "required": false,
              "description": "用户昵称",
              "example": "name"
            },
            {
              "name": "Gender",
              "type": "integer",
              "required": false,
              "description": "性别 默认0 未知 1 男性 2 女性",
              "example": "1"
            },
            {
              "name": "Age",
              "type": "integer",
              "required": false,
              "description": "年龄 默认0 未知",
              "example": "19"
            },
            {
              "name": "Level",
              "type": "integer",
              "required": false,
              "description": "用户等级，默认0 未知 1 低 2 中 3 高",
              "example": "1"
            },
            {
              "name": "Phone",
              "type": "string",
              "required": false,
              "description": "手机号",
              "example": "176****2131"
            },
            {
              "name": "Desc",
              "type": "string",
              "required": false,
              "description": "用户简介，长度不超过5000字",
              "example": "Desc01"
            },
            {
              "name": "HeadUrl",
              "type": "string",
              "required": false,
              "description": "用户头像图片链接",
              "example": "https://cmstest-123.cos.ap-guangzhou.myqcloud.com/image.jpg"
            },
            {
              "name": "RoomId",
              "type": "string",
              "required": false,
              "description": "群聊场景房间ID",
              "example": "RoomId_1"
            },
            {
              "name": "GroupId",
              "type": "string",
              "required": false,
              "description": "群聊场景群ID",
              "example": "GroupId_1"
            },
            {
              "name": "GroupSize",
              "type": "integer",
              "required": false,
              "description": "群聊场景群用户数",
              "example": "10"
            },
            {
              "name": "ReceiverId",
              "type": "string",
              "required": false,
              "description": "消息接收者ID",
              "example": "userid_1"
            },
            {
              "name": "SendTime",
              "type": "string",
              "required": false,
              "description": "消息生成时间，毫秒",
              "example": "2025-05-15 15:40:06"
            }
          ]
        }
      ],
      "required": [
        "BizType",
        "Type",
        "Tasks"
      ]
    },
    {
      "name": "DescribeTaskDetail",
      "description": "通过查看任务详情 DescribeTaskDetail 接口，可主动轮询获取检测结果详情。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务ID，创建任务后返回的TaskId字段",
          "example": "w-video-aqwfdNiA4vq3Zysfa1"
        },
        {
          "name": "ShowAllSegments",
          "type": "boolean",
          "required": false,
          "description": "是否展示所有分片，默认只展示命中规则的分片",
          "example": "true"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DescribeTasks",
      "description": "通过查看审核任务列表接口，可查询任务队列；您可根据多种业务信息（业务类型、审核结果、任务状态等）筛选审核任务列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "该参数表示任务列表每页展示的任务条数，**默认值为10，最大值为100**（每页展示10条任务）。",
          "example": "10"
        },
        {
          "name": "Filter",
          "type": "object",
          "required": false,
          "description": "该参数表示任务筛选器的输入参数，可根据业务类型、审核文件类型、处理建议及任务状态筛选想要查看的审核任务，具体参数内容请参见TaskFilter数据结构的详细描述。",
          "example": "无",
          "children": [
            {
              "name": "BizType",
              "type": "string",
              "required": false,
              "description": "任务业务类型",
              "example": "default"
            },
            {
              "name": "Type",
              "type": "string",
              "required": false,
              "description": "任务类型，可选：VIDEO，AUDIO， LIVE_VIDEO, LIVE_AUDIO",
              "example": "VIDEO"
            },
            {
              "name": "Suggestion",
              "type": "string",
              "required": false,
              "description": "建议，可选：Pass, Review,Block",
              "example": "Pass"
            },
            {
              "name": "TaskStatus",
              "type": "string",
              "required": false,
              "description": "状态，可选：PENDING，RUNNING，ERROR，FINISH，CANCELLED",
              "example": "FINISH"
            }
          ]
        },
        {
          "name": "PageToken",
          "type": "string",
          "required": false,
          "description": "该参数表示翻页时使用的Token信息，由系统自动生成，并在翻页时向下一个生成的页面传递此参数，以方便快速翻页功能的实现。当到最后一页时，该字段为空。",
          "example": "aEjUgqOnIv0S1ZxQ.aEJUb42r3tX61Y-a"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": false,
          "description": "该参数表示任务列表的开始时间，格式为ISO8601标准的时间戳。**默认值为最近3天**，若传入该参数，则在这一时间到EndTime之间的任务将会被筛选出来。备注：该参数与Filter共同起到任务筛选作用，二者作用无先后顺序。",
          "example": "2025-06-05T00:00:00+08:00"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "该参数表示任务列表的结束时间，格式为ISO8601标准的时间戳。**默认值为空**，若传入该参数，则在这StartTime到这一时间之间的任务将会被筛选出来。备注：该参数与Filter共同起到任务筛选作用，二者作用无先后顺序。",
          "example": "2025-06-06T23:59:59+08:00"
        }
      ],
      "required": []
    }
  ]
}