请求接口#

视频流检测接口,可识别: 截帧画面中,涉政、色情、广告,暴恐等监管风险;同时可结合您的业务场景,识别人脸、LOGO、动植物等业务内容。 音频片段中,涉政、色情、广告等监管风险;同时可结合您的业务场景,识别性别,音色,未成年等业务内容。

接口说明#

接口用于提交视频流鉴定等相关信息,稳定拉流后将持续回调对应的识别结果至指定的callback地址。

接口要求#

通信协议:http或https协议 请求方法:POST方法 字符编码:utf-8 参数格式:所有请求参数和返回参数都是采用json格式

支持协议#

普通流地址,目前支持rtmp、rtmps、hls、http、https协议,支持flv,m3u8等格式。

回调机制#

当用户收到推送结果,并返回HTTP状态码为200时,表示推送成功;否则系统将进行重试推送(直至达到重试次数上限)重试逻辑为间隔[5,10,15,20,25,30,35,40,45,50,55,60]秒后重试,12次之后依然失败则不在重试

重试拉流机制#

为防止网络异常导致的拉流失败问题发生,数美视频流服务设置了拉流失败后的重试机制,具体机制如下: 普通流、即构/腾讯/火山流:总共会重试12次,每次持续五分钟,时间间隔为【5、10、15、20.....60秒】。例如,数美会先进行5分钟的持续拉流,拉不到的话,间隔5秒后再持续5分钟拉流,如果还拉不到则间隔10秒后再次进行5分钟拉流,以此类推。 声网流:无重试,拉流5分钟超时后断开。

超时时间#

建议超时时间:7s 内部处理的超时时间为3s,且会重试一次。正常接口返回时间100ms之内

历史版本#

历史版本

请求#

请求地址#

集群请求地址支持产品列表
上海视频流集群http://api-videostream-sh.fengkongcloud.com/videostream/v4中文视频流
新加坡视频流集群http://api-videostream-xjp.fengkongcloud.com/videostream/v4中文视频流 英语视频流 阿语视频流

请求参数#

参数名称类型是否必传最大长度参数说明
accessKeystring20公司密钥。用于权限认证,开通服务时由数美提供
eventIdstring64事件标识。需要与数美约定好取值。
appIdstring64应用标识。此字段强校验,需要提前与数美约定好取值。
imgTypestring64视频流中的画面需要识别的监管类型,和imgBusinessType至少传一个。 可选值: POLITY:涉政识别 EROTIC:色情&性感违规识别 VIOLENT:暴恐&违禁识别 QRCODE:二维码识别 ADVERT:广告识别 IMGTEXTRISK:图片文字违规识别 如果需要识别多个功能,通过下划线连接,如POLITY_QRCODE_ADVERT用于涉政、二维码和广告组合识别
audioTypestring64视频流中的音频需要识别的监管类型,和audioBusinessType至少传一个。 可选值: POLITY:涉政识别 EROTIC:色情识别 ADVERT:广告识别 DIRTY: 辱骂识别 ADLAW:广告法 MOAN:娇喘识别 AUDIOPOLITICAL:声音涉政 ANTHEN:国歌识别 NONE:不检测音频 如需做组合识别,通过下划线连接即可,例如POLITY_EROTIC用于涉政和色情识别
imgBusinessTypestring128视频流中的画面需要识别的业务类型, 和imgType至少传一个,可选值见业务标签类型
audioBusinessTypestring128视频流中的音频业务识别类型,和audioType至少传一个。 可选值: SING:唱歌识别 LANGUAGE:语种识别(中文、英文、粤语、藏语、维吾尔语、朝鲜语、蒙语、其他) MINOR:未成年人识别 GENDER:性别识别 TIMBRE:音色识别,需要同时传入GENDER才能生效, APPNAME:app名称识别。 如果需要识别多个功能,通过下划线连接
imgCallbackstring1024图片回调地址 将视频流中截帧图片的检测结果通过该地址回调给用户
audioCallbackstring1024音频回调地址 将视频流中音频片段的检测结果通过该地址回调给用户;需要识别音频时必传
dataobject-请求的数据内容,大小不超过1M
streamTypestring-视频流类型 可选值为: NORMAL:普通流地址,目前支持rtmp、rtmps、hls、http、https协议 AGORA:声网审核 TRTC:腾讯审核 ZEGO:即构审核 VOLC:火山引擎审核 ALI:阿里云审核 注意:使用RTC的SDK录制方案的时候,可能会在RTC侧产生额外的录制费用,具体费用请咨询相关RTC厂商
tokenIdstring64用户账号标识。建议传入用户ID,可用于灌水、广告等行为维度的风险识别。
audioDetectStepint32-视频流中的音频审核步长。单位为个,取值范围为1-36整数,取1表示跳过一个10S的音频片段审核,取2表示跳过二个,以此类推。不使用该功能时音频内容全部过审
detectFrequencyint32-视频流中的画面截帧频率间隔。单位为秒,取值范围为1~60秒,遇到小数向下取整,不足1的按照1秒处理,如不传递默认3秒截帧一次。
detectStepint32-视频流截帧图片检测步长。已截帧图片每个步长只会检测一次,取值大于等于1。不使用该功能时所有截帧全部过审
deviceIdstring128数美设备指纹标识。由数美SDK生成,用于用户行为分析。
genderstring-用户性别,建议值: male:男性 female:女性 ambiguity:性别不明
imgBusinessDetectStepint32-图片业务标签检测步长。每个步长只会检测一次imgBusinessType,取值大于等于1。< >默认值=1,代表所有片段都审核业务标签。
ipstring64客户端公网IP地址。该参数用于IP维度的用户行为分析。
langstring-语言类型。可指定对截帧及音频片段内容检测的语种类型(默认为中文),可选值: zh:中文 en:英文 ar:阿拉伯语
levelint32-用户等级,针对不同等级的用户可配置不同拦截策略。可选值:0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等; 1:较低级用户,典型如低活跃或低等级用户等; 2:中等级用户,典型如具备一定活跃或等级中等的用户等; 3:较高级用户,典型如高活跃或高等级用户等; 4:最高级用户,典型如付费用户、VIP用户等
receiveTokenIdstring64消息接收者的tokenId由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
returnAllImgint32-返回截帧识别结果的风险等级。可选值如下:(默认值为0) 0:返回风险等级为非pass的图片审核信息。 1:返回所有风险等级的图片审核信息。
returnAllTextint32-返回音频识别结果的风险等级。可选值如下(默认为0): 0:返回风险等级为非pass的音频片段与文本内容。 1:返回所有风险等级的音频片段与文本内容。
returnFinishInfoint32-视频流结束回调通知。可选值如下:(默认值为0) 1:审核结束时发起结束通知,回调参数增加statCode状态码。 0:审核结束时不发送结束通知。
returnPreAudioint32-是否返回前一片段信息。可选值如下: 1:返回的preAudioUrl字段包含前10秒和当前10秒共20秒的音频片段链接。 0:不返回前一片段信息。
returnPreTextint32-是否返回前一片段文本信息。可选值如下: 1:返回的content字段包含前10秒和当前10秒共20秒的音频片段文本内容 0:不返回前一片段文本信息。
roomstring64直播间/游戏房间编号,可针对单个房间制定不同的策略
streamNamestring64视频流名称 用于后台界面展示,建议传入
urlstring600要检测的视频流的普通流的url地址
agoraParamobject-声网录制参数(当streamType为AGORA时必传)
appIdstring64声网提供的应用标识
channelstring64声网提供的频道名
channelProfileint3232声网录制的频道模式,取值: 0: 通信(默认),即常见的 1 对 1 单聊或群聊,频道内任何用户可以自由说话; 1: 直播,有两种用户角色: 主播和观众。
enableH265Supportboolean-是否支持录制H.265视频流。 false:(默认)不支持录制 H.265 视频流。频道内的远端用户无法发 H.265 视频流。 true:支持录制 H.265 视频流。
enableIntraRequestboolean-是否启用关键帧请求。该参数默认为true,可改善弱网下的音视频体验。如需使单流模式下录制的视频可指定播放位置,须将enableIntraRequest设为 false。 false:禁用关键帧请求,频道内的所有发流端均每2秒发送一次关键帧。禁用后,单流模式下录制的视频可指定播放位置。 true:由发流端控制是否启用关键帧请求。启用后,单流模式下录制的视频文件播放时无法指定播放位置。
subscribeModestring-订阅模式。 AUTO: 自动订阅房间内的所有流,不设置subscribeMode时候的默认行为 UNTRUSTED: 配合untrustedUserIdList只订阅该列表指定的用户流,此种模式下如果untrustedUserIdList列表为空,参数错误,因为无法订阅任何流 TRUSTED: 配合trustedUserIdList只订阅该列表以外的用户流,此种模式下如果一定时间下没有trustedUserIdList名单外的用户进入房间,即untrustedUserIdList列表为空,数美将主动结束审核。
tokenstring64安全要求较高的用户可以使用 token进行认证,生成方式详见声网文档:(https://docs.agora.io/cn/Recording/token_server?platform=CPP) >建议将token的有效期设置超过频道的持续时间,防止token失效导致无法拉流。当前声网支持的最大token有效期为24小时,因此当频道持续时间超过24小时的时候,需要处理token失效的问题。处理方法:在请求参数中设置开启音频流结束回调通知(设置returnFinishInfo为1)。当回调接收到审核结束通知(statCode为1),并且原因是由于拉流的token无效或过期,如果频道仍然存在并且需要继续审核,则生成新的token,将频道重新送审。
uidint326432位无符号整数。当token存在时,必须提供生成token时所使用的用户ID。 注意,此处需要区别实际房间中的用户uid,提供给服务端录制所用的uid不允许在房间中存在
trustedUserIdListarray-信任用户的列表,subscribeMode为TRUSTED时生效,不允许为空,数美不会订阅房间内该列表指定的用户流 逗号拼接的UID数组,如[1,2],用户上限17个
untrustedUserIdListarray-非信任用户的列表,subscribeMode为UNTRUSTED时生效,不允许为空,数美只订阅房间内该列表指定的用户流 逗号拼接的UID数组,如[1,2],用户上限17个
aliParamobject-阿里引擎录制参数(当streamType为ALI时必传)
roomstring64房间ID,需要和生成token使用的的channelID完全一致。服务端以房间为单位拉流录制。room为唯一标志,相同的room不会重复拉流。
tokenstring64用于拉流端加入频道,生成方式详见文档:https://help.aliyun.com/zh/live/user-guide/token-based-authentication,每次上传审核都需要重新生成新的token。
userIdint3232阿里用户账号标识。
extraobject-辅助信息
passThroughobject1024客户传入透传字段。数美内部不会对该字段进行识别处理,随结果返回给用户。
trtcParamobject-腾讯录制参数(当streamType为TRTC时必传)
demoSencesint32-录制类型可选值: 分流录制:2 合流录制:4
sdkAppIdint3264腾讯提供的sdkAppId
strRoomIdstring128房间号码。取值说明:只允许包含(a-zA-Z),数字(0-9)以及下划线和连词符 若您选用strRoomId时,需注意strRoomId和roomId两者都有值优先选用roomId
userIdstring32分配给录制端的userId,限制长度为32bit,只允许包含(a-zA-Z),数字(0-9)以及下划线和连词符
userSigstring128录制userId对应的验证签名,相当于登录密码
roomIdstring128房间号码。取值范围:【1-4294967294】roomId与strRoomId必传一个,若两者都有值优先选用roomId 注意:目前一个房间最多只能审核8个用户
volcParamobject-火山引擎录制参数(当streamType为VOLC时必传)
appIdstring64火山提供的应用标识
roomIdstring128房间号
tokenstring64录制userId对应的验证签名,相当于登录密码
userIdstring32分配给录制段的userId,限制长度为32bit,只允许包含(a-zA-Z),数字(0-9)以及下划线和连词符
zegoParamobject-即构录制参数(当streamType为ZEGO时必传)
roomIdstring64zego的房间号
tokenIdstring64zego提供的身份验证信息,获取zego的identify_token用于登录,生成方式详见zego文档:https://doc-zh.zego.im/article/15258 注意tokenId是唯一标识上传鉴黄每一次请求都需要重新生成新的

响应#

返回参数#

参数名称类型是否必返参数说明
requestIdstring数美请求唯一标识
messagestring和code对应: 1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1904 : 流路数超限 9101:无权限操作
codeint321100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1904 : 流路数超限 9101:无权限操作
detailobject
dupRequestIdstring表示重复的requestId 当errorcode为1001,表示重复推流时,会返回dupRequestId字段 例如当第一次请求的时候没有收到返回,但该音频流实际已经开始审核了,没有requestId无法主动关闭审核 可以再次请求,收到重复推流的信息,通过返回的dupRequestId调用关闭审核接口
errorcodeint321001:重复推流

流片段回调参数#

以下参数,除code、message、requestId以外,其他必返参数均为在code返回1100时为必返。

参数名称类型是否必返参数说明
requestIdstring数美请求唯一标识
messagestring和code对应: 1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1904 : 流路数超限 9101:无权限操作
codeint321100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1904 : 流路数超限 9101:无权限操作
statCodeint32回调状态码。状态码对应关系: 0 :审核结果回调 1 :流结束结果回调
contentTypeint32用来区分音频和图片回调。可能取值如下: 1:该回调为图片回调 2:该回调为音频回调
auxInfoobject辅助信息,请求参数data中extra的passThrough放入该值返回
passThroughobject客户传入透传字段。数美内部不会对该字段进行识别处理,随结果返回给用户。
frameDetailobject截帧图片信息风险详情。有风险片段或returnAllImg=1时返回
imgUrlstring截帧图片地址
riskDescriptionstring标签解释 对于命中用户自定义名单时返回:命中自定义名单; 当riskLevel为PASS时返回正常; 其他情况展现形式为一级标签:二级标签:三级标签的中文名,仅供人了解风险原因时作为参考,程序请勿依赖该参数的值做逻辑处理
riskLabel1string一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签, 当riskLevel为PASS时为空
riskLevelstring识别结果,可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
allLabelsarray全部的风险标签列表
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
riskDescriptionstring当riskLevel为PASS时返回正常; 其他情况展现形式为:"一级标签:二级标签:三级标签"的中文名 仅供人了解风险原因时作为参考,程序请勿依赖该参数的值做逻辑处理
riskLabel1string一级风险标签
riskLabel2string二级风险标签
riskLabel3string三级风险标签
riskLevelstring识别结果,可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
riskDetailobject风险详情信息
riskSourceint32风险来源,可能取值: 1000:无风险 1001:文字风险 1002:视觉图片风险
face_numint32人脸数量
person_numint32人像数量
facesarray图片中涉政人物的名称及位置信息。当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个)
face_ratiofloat人脸占比,在区间0-1,数值越大,人脸占比越高
idstring编号,图片同一个位置下的人在不同标签下的编号相同。 如果同一个人在图片中出现n次,分配n个ID
namestring人物名称
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
locationarray人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
objectsarray物品信息。返回图片中标识或物品的名称及位置信息
idstring物品或标识编号,保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
qrContentstring返回图片中识别的二维码地址
locationarray物品位置信息 该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
ocrTextobject返回图片中文字识别内容,当请求参数imgType字段包含IMGTEXTRISK或ADVERT时存在
textstring图片中识别出的文字
matchedListsarray命中的客户自定义名单信息 仅在命中客户自定义名单时返回
namestring命中的名单名称
wordsarray命中的这个名单中的敏感词信息
wordstring命中的敏感词
positionarray敏感词所在位置
riskSegmentsarray高风险片段内容。检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在
segmentstring辅助信息 高风险内容片段
positionarray高风险内容片段所在位置 下标从0开始计数
personsarray图片中人物的名称及位置信息。当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个)
idstring编号,保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比。在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
locationarray人像位置坐标
auxInfoobject辅助信息
beginProcessTimeint32开始处理的时间(13位时间戳)
finishProcessTimeint32结束处理的时间(13位时间戳)
detectTypeint32用来区分截帧图片是否过了检测 可能取值如下:(仅当请求参数传了detectStep时才会返回该参数) 1:截帧图片过了检测 2:截帧图片没过检测
imgTimestring截帧图片发生时间 视频流截帧图片违规发生的时间(绝对时间)
roomstring房间号
similarityDedupint32辅助参数。可能取值如下:(仅当相似帧去重推审功能生效时,将外层riskLevel从reject/review变成pass时返回该参数,其他情况不返回该字段) 值为1,相似帧去重推审功能生效
strUserIdstring用户标识,用于区分房间内违规用户,与请求参数中的userId无关,分流的用户id。以下情况会返回该字段: ZEGO流按房间号审核。 TRTC流分流审核。 VOLC流审核。 ALI流审核。
userIdint32声网用户账号标识。仅分流情况下存在,返回的userId是实际房间中的用户id,与请求参数中的uid无关。
riskDetailobject风险详情信息
riskSourceint32风险来源,可能取值: 1000:无风险 1001:文字风险 1002:视觉图片风险
face_numint32人脸数量
person_numint32人像数量
facesarray图片中涉政人物的名称及位置信息。当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个)
face_ratiofloat人脸占比,在区间0-1,数值越大,人脸占比越高
idstring编号,图片同一个位置下的人在不同标签下的编号相同。 如果同一个人在图片中出现n次,分配n个ID
namestring人物名称
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
locationarray人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
objectsarray物品信息。返回图片中标识或物品的名称及位置信息
idstring物品或标识编号,保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
qrContentstring返回图片中识别的二维码地址
locationarray物品位置信息 该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
ocrTextobject返回图片中文字识别内容,当请求参数imgType字段包含IMGTEXTRISK或ADVERT时存在
textstring图片中识别出的文字
matchedListsarray命中的客户自定义名单信息 仅在命中客户自定义名单时返回
namestring命中的名单名称
wordsarray命中的这个名单中的敏感词信息
wordstring命中的敏感词
positionarray敏感词所在位置
riskSegmentsarray高风险片段内容。检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在
segmentstring辅助信息 高风险内容片段
positionarray高风险内容片段所在位置 下标从0开始计数
personsarray图片中人物的名称及位置信息。当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个)
idstring编号,保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比。在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
locationarray人像位置坐标
businessLabelsarray业务标签列表
businessDescriptionstring业务标签中文描述,格式为"一级标签:二级标签:三级标签"的中文名称
businessLabel1string一级业务标签
businessLabel2string二级业务标签
businessLabel3string三级业务标签
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
confidenceLevelint32置信等级,可选值在0~2之间,值越大,可信度越高
businessDetailobject业务标签详情
face_numint32人脸数量
person_numint32人像数量
facesarray图片中涉政人物的名称及位置信息。当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个)
face_ratiofloat人脸占比,在区间0-1,数值越大,人脸占比越高
idstring编号,图片同一个位置下的人在不同标签下的编号相同。 如果同一个人在图片中出现n次,分配n个ID
namestring人物名称
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
locationarray人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
objectsarray物品信息。返回图片中标识或物品的名称及位置信息
idstring物品或标识编号,保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
qrContentstring返回图片中识别的二维码地址
locationarray物品位置信息 该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
personsarray图片中人物的名称及位置信息。当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个)
idstring编号,保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比。在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
locationarray人像位置坐标
audioDetailobject音频片段信息。有风险片段或returnAllText=1时返回
audioUrlstring音频片段地址。
riskDescriptionstring标签解释 对于命中用户自定义名单时返回:命中自定义名单; 当riskLevel为PASS时返回正常; 其他情况展现形式为一级标签:二级标签:三级标签的中文名,仅供人了解风险原因时作为参考,程序请勿依赖该参数的值做逻辑处理
riskLabel1string一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签, 当riskLevel为PASS时为空
riskLevelstring识别结果,可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
vadCodeint32是否静音片段。 0:静音片段 1:非静音片段
allLabelsarray全部的风险标签列表
riskDescriptionstring风险描述。当riskLevel为PASS时返回:正常。格式为:"一级风险标签:二级风险标签:三级风险标签",的中文名称。对于命中用户自定义名单时返回:命中自定义名单。
riskLabel1string一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签, 当riskLevel为PASS时为空
riskLevelstring识别结果,可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
contentstring视频流中音频识别出的文字内容。当returnPreText值为1,且当前音频片段为reject时,返回当前10秒和前10秒共20秒的音频片段文本内容。否则仅返回当前片段文本内容。
preAudioUrlstring前一个音频片段链接。当returnPreAudio值为1,且当前音频片段为reject时,返回当前10秒和前10秒共20秒的音频片段链接。否则不返回。
auxInfoobject辅助信息
audio_endtimestring违规内容结束时间(绝对时间)
audio_starttimestring违规内容开始时间(绝对时间)
beginProcessTimeint32开始处理的时间(13位时间戳)
finishProcessTimeint32结束处理的时间(13位时间戳)
roomstring房间号
strUserIdstring用户标识,用于区分房间内违规用户,与请求参数中的userId无关,分流的用户id。以下情况会返回该字段: ZEGO流按房间号审核。 TRTC流分流审核。 VOLC流审核。 ALI流审核。
userIdint32声网用户账号标识。仅分流情况下存在,返回的userId是实际房间中的用户id,与请求参数中的uid无关。
passThroughobject客户传入透传字段。数美内部不会对该字段进行识别处理,随结果返回给用户。
businessLabelsarray业务标签列表
businessDescriptionstring业务标签中文描述,格式为"一级标签:二级标签:三级标签"的中文名称
businessLabel1string一级业务标签
businessLabel2string二级业务标签
businessLabel3string三级业务标签
probabilityfloat置信度。可选值在0~1之间,值越大,可信度越高
confidenceLevelint32置信等级,可选值在0~2之间,值越大,可信度越高
businessDetailobject业务标签详情
riskSourceint32风险来源,可能取值: 1000:无风险 1001:文字风险 1003:音频语音风险
audioTextstring该片段识别的文字内容
matchedListsarray命中的客户自定义名单信息 仅在命中客户自定义名单时返回
namestring名单名称
wordsarray命中的这个名单中的敏感词信息
wordstring命中的敏感词
positionarray高风险内容片段所在位置 下标从0开始计数
riskSegmentsarray高风险片段内容。检测音频包含未成年,唱歌等风险内容的时候存在
segmentstring辅助信息 高风险内容片段
positionarray高风险内容片段所在位置 下标从0开始计数
riskDetailobject风险详情信息
riskSourceint32风险来源,可能取值: 1000:无风险 1001:文字风险 1003:音频语音风险
audioTextstring该片段识别的文字内容
matchedListsarray命中的客户自定义名单信息 仅在命中客户自定义名单时返回
namestring名单名称
wordsarray命中的这个名单中的敏感词信息
wordstring命中的敏感词
positionarray高风险内容片段所在位置 下标从0开始计数
riskSegmentsarray高风险片段内容。检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在
segmentstring辅助信息 高风险内容片段
positionarray高风险内容片段所在位置 下标从0开始计数
tokenProfileLabelsarray账号属性标签。仅在tokenId传入且标签服务开通时返回
descriptionstring标签描述
label1string一级标签
label2string二级标签
label3string三级标签
timestampint32打标签时间戳 13位Unix时间戳,单位:毫秒
tokenRiskLabelsarray账号风险标签。仅在tokenId传入且标签服务开通时返回
descriptionstring标签描述
label1string一级标签
label2string二级标签
label3string三级标签
timestampint32打标签时间戳 13位Unix时间戳,单位:毫秒

流结束回调参数#

仅当returnFinishInfo为1时返回

参数名称类型是否必返参数说明
requestIdstring数美请求唯一标识
messagestring和code对应: 1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1904 : 流路数超限 9101:无权限操作
codeint321100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1904 : 流路数超限 9101:无权限操作
riskLevelstring回调结束时返回整体流的处置建议。可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
statCodeint32回调状态码,当returnFinishInfo为1时存在。状态码对应关系: 0 :审核结果回调 1 :流结束结果回调。
contentTypeint32用来区分音频和图片回调结束。可能取值如下: 1:该回调为图片审核结束回调 2:该回调为音频审核结束回调
pullStreamSuccessbool拉流是否成功。可能取值如下: true:拉流成功 false:拉流失败 如果一张截图都没有获取成功即认为拉流失败
auxInfoobject辅助信息
streamTimeint32流审核时长。流结束后最后一次返回,代表送审时长,如有间隔审核逻辑时,和流真实时长可能不一致
requestParamsobject返回请求参数data中的所有字段。contentType为2时返回
detailobject详情信息。contentType为1时返回
requestParamsobject返回请求参数data中的所有字段

示例#

请求示例#

{
"accessKey": "*********",
"appId": "defaulttest",
"audioBusinessType": "SING_LANGUAGE",
"audioCallback": "http://www.xxx.top/callbackxxx",
"audioType": "POLITY_EROTIC_ADVERT_MOAN",
"data": {
"detectFrequency": 10,
"detectStep": 1,
"extra": {
"passThrough": {
"passThrough1": "111",
"passThrough2": "222",
"passThrough3": "333"
}
},
"ip": "123.171.34.4",
"lang": "zh",
"returnAllImg": 1,
"returnAllText": 1,
"returnPreAudio": 1,
"returnPreText": 1,
"room": "5e1854a6a0a79d0001a09bc3",
"streamType": "NORMAL",
"tokenId": "123",
"url": "http://rtmp.xxxx.cn/live/3637778raLSXdOdu.flv"
},
"eventId": "VIDEOSTREAM",
"imgBusinessType": "BODY_FOOD_3CPRODUCTSLOGO",
"imgCallback": "http://www.xxx.top/callbackxxx",
"imgType": "POLITY_EROTIC_ADVERT"
}

返回示例#

{
"code": 1100,
"message": "成功",
"requestId": "66fb85e3149bb9e13d6c72161cc6c6cf"
}

截帧图片回调示例#

{
"auxInfo": {
"passThrough": {
"passThrough1": "111",
"passThrough2": "222",
"passThrough3": "333"
}
},
"code": 1100,
"contentType": 1,
"frameDetail": {
"allLabels": [
{
"riskDescription": "涉政:涉政:涉政",
"riskLabel1": "politics",
"riskLabel2": "shezheng",
"riskLabel3": "shezheng",
"riskLevel": "REJECT"
}
],
"auxInfo": {
"beginProcessTime": 1639825248361,
"detectType": 1,
"finishProcessTime": 1639825248809,
"imgTime": "2021-12-18 19:00:48.375",
"room": "5e1854a6a0a79d0001a09bc3"
},
"businessLabels": [],
"imgUrl": "http://bj.cos.ap-beijing.xxx.com/image/1639825145166_vs130_1639825248361471656.jpg",
"riskDescription": "涉政:涉政:涉政",
"riskDetail": {
"ocrText": {
"text": "第四页(ban第五页(violence"
},
"riskSource": 1002
},
"riskLabel1": "politics",
"riskLabel2": "shezheng",
"riskLabel3": "shezheng",
"riskLevel": "REJECT"
},
"message": "成功",
"requestId": "1639825145166_vs130_1639825248361471656"
}

音频片段回调示例#

{
"audioDetail": {
"allLabels": [
{
"riskDescription": "涉政:一号领导:一号领导",
"riskLabel1": "politics",
"riskLabel2": "yihaolingdao",
"riskLabel3": "yihaolingdao",
"riskLevel": "REJECT"
}
],
"audioText": "作作出重要指示强调在全面建设社会主义现代化国家新征程中职业教育前途广阔中共中央总书记国家主",
"audioUrl": "http://bj-voice-mp3-1251671073.cos.ap-beijing.myqcloud.com/POST_VIDEOSTREAM%2FPOST_VIDEOSTREAM_AUDIO%2FMP3%2F20221027%2Fy28f8a4f1264085b321f12223wqed1121retestpvvvvv44321we12_3.mp3?q-sign-algorithm=sha1&q-ak=AKIDg9LHyOYSAcmfHekZ6NN6XidHflbASUHn&q-sign-time=1666876123%3B1669468123&q-key-time=1666876123%3B1669468123&q-header-list=host&q-url-param-list=&q-signature=f32da45be186fd4a8ed063e499d3f4e0f4f5fc19",
"auxInfo": {
"audioEndTime": "2022-10-27 21:08:42",
"audioStartTime": "2022-10-27 21:08:32",
"beginProcessTime": 1666876123332,
"finishProcessTime": 1666876123893,
"room": "y1123413312ewe24sv2"
},
"businessLabels": [],
"content": "现代化国家新征程中职业教育前途广阔中共中央总书记国家主席中央军委主席习近平近日对职业教育工作作作出重要指示强调在全面建设社会主义现代化国家新征程中职业教育前途广阔中共中央总书记国家主",
"preAudioUrl": "http://bj-voice-mp3-1251671073.cos.ap-beijing.myqcloud.com/POST_VIDEOSTREAM%2FPOST_VIDEOSTREAM_AUDIO%2FMP3%2F20221027%2Fy28f8a4f1264085b321f12223wqed1121retestpvvvvv44321we12_3_pre.mp3?q-sign-algorithm=sha1&q-ak=AKIDg9LHyOYSAcmfHekZ6NN6XidHflbASUHn&q-sign-time=1666876123%3B1669468123&q-key-time=1666876123%3B1669468123&q-header-list=host&q-url-param-list=&q-signature=449fdcab8a3c11d5132f43f78c61e6663f5c08d6",
"riskDescription": "涉政:一号领导:一号领导",
"riskDetail": {
"audioText": "作作出重要指示强调在全面建设社会主义现代化国家新征程中职业教育前途广阔中共中央总书记国家主",
"riskSource": 1001
},
"riskLabel1": "politics",
"riskLabel2": "yihaolingdao",
"riskLabel3": "yihaolingdao",
"riskLevel": "REJECT"
},
"code": 1100,
"contentType": 2,
"message": "成功",
"requestId": "y28f8a4f1264085b321f12223wqed1121retestpvvvvv44321we12_3",
"statCode": 0
}

流结束回调示例#

{
"auxInfo": {
"streamTime": 70
},
"code": 1100,
"contentType": 1,
"detail": {
"requestParams": {
"detectFrequency": 10,
"detectStep": 1,
"extra": {
"passThrough": {
"passThrough1": "111",
"passThrough2": "222",
"passThrough3": "333"
}
},
"ip": "123.171.34.4",
"lang": "zh",
"returnAllImg": 1,
"returnAllText": 1,
"returnPreAudio": 1,
"returnPreText": 1,
"room": "5e1854a6a0a79d0001a09bc3",
"streamType": "NORMAL",
"tokenId": "123",
"url": "http://rtmp.xxxx.cn/live/3637778raLSXdOdu.flv"
}
},
"message": "成功",
"pullStreamSuccess": true,
"requestId": "5515ce1f9b474a6c4a3d79a8dfcaeaf4",
"riskLevel": "PASS",
"statCode": 1
}

附录#

业务标签类型#

业务标签识别类型类型说明备注
AGE人脸-年龄可识别未成年人
GENDER人脸-性别
BEAUTY人脸-颜值
RACE人脸-人种如黑种人、白种人、黄种人
FACEDETECTION人脸-人脸检测如识别无人脸、真人、口罩人脸、正脸、侧脸等
FAKEFACE人脸-伪造人脸
FACECOMPARE人脸-人脸对比
PUBLICFIGURE人物-公众人物如识别知名明星、网红等
TAINTEDSTAR人物-劣迹人物
POSTURE人像-人像姿态如识别坐姿、跪姿等
DRESS人像-人像穿着如识别jk、汉服等
TEMPERAMENT人像-人像气质如成熟大叔、靓丽女神等
BODY人体如识别头发、眼睛、鼻子等
PICTUREFORM画面属性-画面类型如识别动漫、表情包等
PICTURESTRUCT画面属性-画面结构如识别宫格图、桥段图等
LOWVISION画面属性-画面低质如识别模糊、涂抹、马赛克等
LOWCONTNET画面属性-内容低质如识别点线密集、虫类密集等
LIVEPICTURE画面属性-直播画面如识别床上直播、开车直播等
SCREENSHOT画面属性-APP截图(内容搬运)如识别朋友圈截图、聊天截图等
FITNESS场景主题-健身
CATE场景主题-美食
MUSIC场景主题-音乐
SPORTS场景主题-体育
SCENERY场景主题-自然风光如识别天空、大海、草原等
CITYVIEW场景主题-城市风光如识别街景
3CPRODUCTSLOGOLOGO-3C电子类品牌如识别华为、小米、OPPO等LOGO
SHOPPINGAPPSLOGOLOGO-购物比价类应用如识别拼多多等LOGO
RETOUCHAPPSLOGOLOGO-拍摄美化类应用如识别快剪辑、秒拍等LOGO
SOCIALAPPSLOGOLOGO-社交通讯类应用如识别微博、小红书等LOGO
PHOTOMATERIALLOGOLOGO-素材版权类应用如识别CFP等LOGO
NEWSAPPSLOGOLOGO-新闻阅读类应用如识别新浪、视觉中国等LOGO
ENTERTAINMENTAPPSLOGOLOGO-影音娱乐类应用如识别抖音、快手等LOGO
SPORTSLOGOLOGO-体育赛事如识别奥运会等LOGO
APPARELLOGOLOGO-鞋帽服饰类品牌如识别VANS、H&M等LOGO
ACCESSORIESLOGOLOGO-饰品首饰类品牌如识别AudemarsPiguet、Nomos等LOGO
COSMETICSLOGOLOGO-化妆品类品牌如识别LOTTE、EyesLipsFace等LOGO
FOODLOGOLOGO-食品类品牌如识别Starbucks、LOTTE等LOGO
AUTOTRADEAPPSLOGOLOGO-汽车交易平台类 如识别懂车帝、易车、太平洋汽车、爱卡等LOGO
VEHICLE物品-交通工具
BUILDING物品-建筑
TABLEWARE物品-餐具
FOOD物品-食物
HOMEAPPLICATION物品-家用电器
OFFICESUPPLIES物品-办公用品
FASHION物品-穿着用品
SPORTEQUIPMENT物品-运动器材
TOY物品-玩具
MAKEUP物品-化妆品
DRUGS物品-药品
PAINTING物品-绘画作品
ELECTRONIC物品-电子产品
MEDICALIMAGE物品-医疗影像
FURNITURE物品-家居用品
DAILYSUPPLIES物品-生活用品
CONSTELLATION物品-星座占卜
KITCHENWARE物品-厨房用品
KEEPSAKE物品-纪念品
MAMMAL动物-哺乳动物
BIRDS动物-鸟类
REPTILE动物-爬行动物
FISH动物-鱼
ARTHROPOD动物-节肢动物
COELENTERATE动物腔肠动物
MOLLUSKS动物软体动物
CRUSTACEAN动物甲壳动物
PLANT植物
SETTING场所如识别卫生间、酒店、厨房等
EXTREMEWEATHER极端天气识别如水灾、暴雨、沙尘暴、冰等
LICENCEPLATE车牌识别

在线咨询