创建安全通审核任务

更新时间: 2024/07/05 18:14:15

创建实时音视频安全通审核任务。

功能描述

音视频通话 2.0 安全通功能默认提供中文长音频检测、声纹检测、视频图片色情检测、涉政检测、暴恐检测、低俗检测、广告检测等多种检测类型,默认为机器审核模式,若您有其他内容审核需求,例如更多的检测类型、或者需要人工审核,请联系商务经理进获取更多信息。

创建安全通审核任务后,安全通服务通过虚拟身份加入音视频房间,并对房间中的实时音视频流进行监听、实时检测违规内容。

默认情况下,审核结果以消息抄送形式发送至您在 网易云信控制台 预留的抄送地址。如果本次内容审核需要以其他抄送地址接收审核结果,可以在创建安全通审核任务时,设置 callbackUrl 参数,指定为另一个抄送地址。详细的消息抄送事件请参考 400 实时音视频安全通核抄送

前提条件

  • 已开通安全通服务
  • 已创建音视频房间,且房间中已有一名以上成员。
  • 已配置消息抄送
  • 已为安全通服务在房间中的虚拟用户预留监听 uid 号段,并授权监听 uid 进入房间的 Token。

接口请求地址

  • 请求方法:POST

  • URL:

    HTTPhttps://logic-dev.netease.im/livewallsolution/submit HTTP/1.1
    
  • Content-Type:application/json;charset=utf-8 安全通相关服务端接口的请求结构、请求头、公共参数、字符编码均与其他服务端 API 相同,但 Content-Type 不同,此接口的 Content-Type 为 application/json。

接口请求频率

默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考 如何处理调用服务端 RESTful API 超出频率限制

请求参数

  • 请求中 Header 的设置请参考 请求结构 描述。

  • 请求中 Body 须为 JSON 格式,参数说明如下:

参数名称 类型 是否必选 示例 描述
monitorUid Long 必选 333 安全通虚拟用户加入房间时使用的 uid。请填写您提前为安全通虚拟用户预留的 uid 号码,该 uid 不能与普通用户的 uid 重复。
channelName String 必选 channelExample 需要进行内容审核的音视频房间名称。
您可以通过 查询房间信息 获取 channelName 的值。
detectType Number 可选 0 安全通机器过检的类型。
  • 0(默认值):视频与音频同时检测。
  • 1:仅检测视频。
  • 2:仅检测音频。
默认音频与视频同时检测,您也可以在 网易云信控制台 修改默认的检测类型。此参数未设置时,默认使用 网易云信控制台 配置的检测类型。
scFrequency Integer 可选 3 截图检测频率,取值范围为 1 ~ 600 秒。
默认 5 秒截图检测一次,您也可以在 网易云信控制台 修改默认的截图检测频率。此参数未设置时,默认使用控制台配置的截图检测频率。
callback String 可选 自定义回调信息。请您根据业务情况自行设计该字段内容,成功传入后,审核结果中会原样返回该字段中传入的内容。
长度为 1 ~ 2048 字节。建议设计为能唯一定位到该次请求的数据结构,例如,对用户的昵称进行检测,dataId 可设为用户标识(用户 ID),用户修改多次,每次请求数据的 dataId 可能一致,但是 callback 参数可以设计成定位该次请求的数据结构,例如 callback 字段设计成 JSON,包含 dataId 和请求的时间戳等信息,当然如果不想做区分,也可以直接把 callback 设置成 dataId 的值。
callbackUrl String 可选 http://example.com/your-url 接收本次内容审核结果的抄送地址 URL。
  • 默认情况下,审核结果以消息抄送形式发送至您在 网易云信控制台 预留的消息抄送地址。如果本次内容审核需要以其他抄送地址接收审核结果,可以设置该参数,指定为另一个抄送地址。
  • 为了保证顺利接收数据,请保证该地址的连通性。
  • 消息抄送内容请参考 400 实时音视频安全通核抄送
secretId String 可选 安全通自定义产品的 secretId。
请联系网易云信技术支持在 网易云信控制台 添加自定义产品的 secretId。您可以在网易云信控制台的安全通页面查看对应的 secretId。
  • 如果您的应用在国内和海外都有上线,针对国内和海外需要分别采用不同的内容审核策略,您可以针对国内和海外设置不同 secretId。
  • 如果为空,则使用默认产品的 secretId 进行安全通检测。
autoMaskConfig [JSON Object](#autoMaskConfig) 可选 视频审核自动打码相关配置
stopInSecond int 可选 设定一个时间值,该秒数后由网易云信自动停止安全通检测任务。取值范围为 [1, 259200]。

autoMaskConfig 包含字段如下:

enableMask Boolean 可选 true 是否开启视频审核自动打码。可设置为:
  • true:开启。
  • false(默认):关闭。
    详细信息请参考 安全通审核自动打码
  • maskType Integer 可选 0 打码效果。请设置为 0,即马赛克效果。
    duration Integer 可选 30 打码时长。单位为秒(s),默认值为 15 秒。
    unmaskUids Array of JSON 可选 [123,456] 设置不打码的白名单。请填写不打码用户的 uid 数组。

    返回参数

    参数名称 类型 描述
    code Number 接口调用状态,200 表示成功调用。
    msg String 状态描述。
    result 数组 接口返回结果。通常包含业务相关的返回结果。

    result 字段说明:

    参数名称 类型 描述
    taskId String 本次请求数据标识,可以根据该标识查询数据最新结果。
    status Boolean 请求结果。
    • true:提交成功。
    • false:提交失败。
    dataId String 网易云信为您自动生成的数据唯一标识。如果您对检测结果有任何疑问,请根据 dataId 咨询技术支持。
    evidences Array of JSON 机审证据信息。详细信息请参考 安全通审核自动打码

    示例

    请求示例

    JSON{
        "monitorUid": 1234567,
        "channelName": "channel-name",
        "detectType": 0,
        "scFrequency": 5,
        "callbackUrl": "http://example.com/your-url",
        "autoMaskConfig": {
            "maskType": 0,
            "duration": 5,
            "unmaskUids": [
            ],
            "enableMask": True
        }
    
    }
    

    正常返回示例

    JSON{
        "code": 200,
        "msg": "ok",
        "result": {
                "taskId": "*****",
                "status": true,
                "dataId":*****
            }
    }
    

    错误码

    此接口相关的业务错误码如下:

    错误码(code) 错误信息(msg) 说明
    400 REQUESET FORMAT ERROR 请求格式错误。
    543 SUBMIT TASK ERROR 提交任务错误。
    544 STOP TASK ERROR 停止任务错误。
    547 QUERY SCREENSHOT ERROR 查询截图错误。
    548 QUERY AUDIO ERROR 查询音频错误。
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • 前提条件
    • 接口请求地址
    • 接口请求频率
    • 请求参数
    • 返回参数
    • 示例
    • 请求示例
    • 正常返回示例
    • 错误码