数美智能视频流识别产品API文档#

视频流上传请求#

接口描述#

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

请求URL：#

集群	URL	支持产品列表
上海	`http://api-videostream-sh.fengkongcloud.com/videostream/v4`	中文视频流
新加坡	`http://api-videostream-xjp.fengkongcloud.com/videostream/v4`	中文视频流英语视频流阿语视频流
硅谷	`http://api-videostream-gg.fengkongcloud.com/videostream/v4`	中文视频流英语视频流阿语视频流
印度	`http://api-videostream-yd.fengkongcloud.com/videostream/v4`	中文视频流

请求方法：#

POST

支持协议#

HTTP或HTTPS

字符编码：#

UTF-8

建议超时时间：#

请求参数：#

放在HTTP Body中，采用Json格式，具体参数如下：

请求参数名	类型	参数说明	传入说明	规范
accessKey	string	公司密钥	必传参数	数美分配
appId	string	应用标识	必传参数	需要联系数美服务开通，请使用数美单独提供的传值为准
eventId	string	事件标识	必传参数	用于区分场景数据，需要联系数美服务开通，请使用数美单独提供的传值为准
imgType	string	视频中的画面需要识别的监管类型，和imgBusinessType至少传一个	非必传参数	监管一级标签可选值： `POLITY`：涉政识别 `EROTIC`：色情&性感违规识别 `VIOLENT`：暴恐&违禁识别 `QRCODE`：二维码识别 `ADVERT`：广告识别 `IMGTEXTRISK`：图片文字违规识别如果需要识别多个功能，通过下划线连接，如`POLITY_QRCODE_ADVERT`用于涉政、二维码和广告组合识别
audioType	string	视频流中的音频需要识别的监管类型，和audioBusinessType至少传一个	非必传参数	监管一级标签可选值： `POLITICAL`：涉政识别 `PORN`：色情识别 `AD`：广告识别 `MOAN`：娇喘识别 `AUDIOPOLITICAL`：声音涉政 `ANTHEN`：国歌识别 `ABUSE`: 辱骂识别 `NONE`:不检测音频如需做组合识别，通过下划线连接即可，例如`POLITICAL_PORN_MOAN`用于广告、色情和涉政识别
imgBusinessType	string	视频中的画面需要识别的业务类型，和imgType至少传一个	非必传参数	可选值参考imgBusinessType可选值列表如果需要识别多个功能，通过下划线连接
audioBusinessType	string	视频流中的音频需要识别的业务类型，和audioType至少传一个	非必传参数	业务一级标签可选值： `SING`：唱歌识别 `LANGUAGE`：语种识别 `MINOR`：未成年人识别 `GENDER`：性别识别 `TIMBRE`：音色识别，需要同时传入`GENDER`才能生效
imgCallback	string	图片回调地址	必传参数	将视频流中截帧图片的检测结果通过该地址回调给用户
audioCallback	string	音频回调地址	非必传参数	将视频流中音频片段的检测结果通过该地址回调给用户；需要识别音频时必传
data	json_object	请求数据内容，	必传参数	最长1MB，其中data内容如下

其中，data的内容如下：

请求参数名	类型	参数说明	传入说明	规范
lang	string	语种	必传参数	可选值如下： `zh`：中文 `en`：英语 `ar`：阿语默认值：`zh`
tokenId	string	客户端用户账号唯一标识	必传参数	用于用户行为分析，建议传入用户UID；最长40位
streamType	string	视频流类型	必传参数	可选值为： `NORMAL`：普通流地址，目前支持`rtmp`、`rtmps`、`hls`、`http`、`https`协议 `AGORA`：声网审核 `TRTC`:腾讯审核 `ZEGO`：即构审核 `VOLC`：火山引擎审核注意：使用RTC的SDK录制方案的时候，可能会在RTC侧产生额外的录制费用，具体费用请咨询相关RTC厂商
agoraParam	json_object	声网流参数	非必传参数	要检测的声网流参数（当streamType为`AGORA`时必传），详见agoraParam说明
trtcParam	json_object	腾讯流参数	非必传参数	要检测的TRTC流参数（当streamType为`TRTC`时必传），详见trtcParam说明
zegoParam	json_object	即构流参数	非必传参数	要检测的即构流参数（当streamType为`ZEGO`时必传)，详见zegoParam说明
volcParam	json_object	火山流参数	非必传参数	要检测的即构流参数（当streamType为`VOLC`时必传)，详见volcParam说明
url	string	要检测的视频url地址	非必传参数	要检测的流地址url参数（当streamType为NORMAL时必传）
streamName	string	视频流名称	非必传参数	用于后台界面展示，建议传入
ip	string	客户端IP	非必传参数	该参数用于IP维度的用户行为分析，同时可用于比对数美IP黑库
audioDetectStep	int	视频流中音频的审核步长	非必传参数	单位为个，取值范围为1-36整数，取1表示跳过一个10S的音频片段审核，取2表示跳过二个，以此类推。不使用该功能时音频内容全部过审
returnAllImg	int	用户可根据需求选择返回不同审核结果的图片	非必传参数	可选值如下：（默认值为`0`） `0`：回调reject、review结果的图片审核信息 `1`：回调所有结果的图片审核信息
returnAllText	int	返回音频流片段识别结果的风险等级	非必传参数	可选值如下：(默认值为`0`) `0`：返回风险等级为非pass的音频片段与文本内容 `1`：返回所有风险等级的音频片段与文本内容
returnPreText	int	为1表示返回前10秒和当前10秒共20秒音频片段的文本内容	非必传参数	可选值如下：（默认值为`0`） `1`:返回的content字段包含违规音频前一分钟文本内容 `0`:返回的content字段只包含违规音频片段文本内容
returnPreAudio	int	为1表示返回前10秒和当前10s共20秒的音频片段链接	非必传参数	可选值如下：（默认值为`0`） `1`:返回违规音频前一分钟音频链接 `0`:只返回违规片段音频链接
returnFinishInfo	int	为1时，流结束时返回结束通知	非必传参数	可选值如下：（默认值为`0`） `1`:审核结束时发起结束通知 `0`:审核结束时不发送结束通知，详细返回参数见结束流返回参数
detectFrequency	float	截帧频率间隔	非必传参数	单位为秒，取值范围为1~60s，遇到小数向下取整，不足1的按照1S处理，如不传递默认3s截帧一次
detectStep	int	视频流截帧图片检测步长	非必传参数	已截帧图片每个步长只会检测一次，取值大于等于1。
room	string	直播间/游戏房间编号	非必传参数	可针对单个房间制定不同的策略；（使用声网协议的用户必须传入）
extra	json_object	扩展信息	非必传参数	详见extra说明

data 中，extra的内容如下

请求参数名	类型	参数说明	传入说明	规范
passThrough	json_object	透传字段	非必传参数	该字段内容会随着回调结果一起原样返回

其中，agoraParam内容如下：

请求参数名	类型	参数说明	传入说明	规范
appId	string	声网提供的应用标识	必传参数
channel	string	声网提供的频道名	必传参数
token	string		必传参数	安全要求较高的用户可以使用 token，获取方式详见声网文档token生成方式：https://docs.agora.io/cn/Recording/token
channelProfile	int	声网录制的频道模式	否	可选值如下：（默认值为`0`） `0`: 通信（默认）,即常见的 1 对 1 单聊或群聊，频道内任何用户可以自由说话； `1`: 直播，有两种用户角色: 主播和观众。
uid	int	用户ID	非必传参数	32位无符号整数。当token存在时，必须提供生成token时所使用的用户ID。注意，此处需要区别实际房间中的用户uid，提供给服务端录制所用的uid不允许在房间中存在
subscribeMode	string	订阅模式	非必传参数	`AUTO`: 自动订阅房间内的所有流，不设置subscribeMode时候的默认行为 `UNTRUSTED`: 配合untrustedUserIdList只订阅该列表指定的用户流，此种模式下如果untrustedUserIdList列表为空，参数错误，因为无法订阅任何流 `TRUSTED`: 配合trustedUserIdList只订阅该列表以外的用户流，此种模式下如果一定时间下没有untrustedUserIdList名单外的用户进入房间，数美将主动结束审核。
trustedUserIdList	int_array	信任用户的列表	非必传参数	subscribeMode为`TRUSTED`时生效，不允许为空，数美不会订阅房间内该列表指定的用户流逗号拼接的UID数组，如`[1,2]`，用户上限17个
untrustedUserIdList	int_array	非信任用户的列表	非必传参数	subscribeMode为`UNTRUSTED`时生效，不允许为空，数美只订阅房间内该列表指定的用户流逗号拼接的UID数组，如`[1,2]`，用户上限17个

其中，trtcParam内容如下：

请求参数名	类型	参数说明	传入说明	规范
sdkAppId	int	Y	必传参数	腾讯提供的sdkAppId
demoSences	int	Y	必传参数	录制类型可选值： `2`:分流录制 `4`:合流录制
userId	string	Y	必传参数	分配给录制段的userId，限制长度为32bit，只允许包含（a-zA-Z），数字(0-9)以及下划线和连词符
userSig	string	Y	必传参数	录制userId对应的验证签名，相当于登录密码
roomId	int	Y	非必传参数	房间号码，取值范围：【1-4294967294】roomId与strRoomId必传一个，若两者都有值优先选用roomId 注意：目前一个房间最多只能审核8个用户
strRoomId	string	Y	必传参数	房间号码取值说明：只允许包含（a-zA-Z），数字(0-9)以及下划线和连词符，若您选用strRoomId时，需注意strRoomId和roomId两者都有值，优先选用roomId

其中，data.zegoParam内容如下：

请求参数名	类型	参数说明	传入说明	规范
tokenId	string	Zego鉴权token	必传参数	zego提供的identity_token身份验证信息，用于token登陆（每次开流必须主动调用zego接口获取新的token）
streamId	string	Zego流Id	必传参数	Zego的流ID
testEnv	bool	是否使用zego测试环境	非必传参数	可选值如下：（默认值为`false`） `true`:测试环境 `false`:正式环境

其中，data.volcParam内容如下：

请求参数名	类型	参数说明	传入说明
appId	string	火山提供的应用标识	必传参数
roomId	string	房间号	必传参数
userId	string	分配给录制端的userId	必传参数
token	string	录制userId对应的验证签名，相当于登录密码	必传参数

返回参数#

放在HTTP Body中，采用Json格式，具体参数如下：

返回结果参数名	参数类型	参数说明	是否必返	规范
requestId	string	本次请求的唯一标识	是	请求唯一标识
code	int	请求返回码	是	详见接口响应码列表
message	string	请求返回描述，和请求返回码对应	是	详见接口响应码列表
detail	json_object	描述详细信息	否

其中，detail结构如下：

参数名称	参数类型	参数说明	是否必返	规范
errorCode	int	状态码	否	`1001`：重复推流
dupRequestId	string	表示重复的requestId 当errorCode为1001，表示重复推流时，会返回dupRequestId字段例如当第一次请求的时候没有收到返回，但该音频流实际已经开始审核了，没有requestId无法主动关闭审核可以再次请求，收到重复推流的信息，通过返回的dupRequestId调用关闭审核接口	否

异步回调结果#

接口描述#

用户如果需要服务端主动对视频检测结果进行回调，则需要在请求参数中指定回调协议接口URL callback参数，服务端根据该参数在视频审核完成后，主动回调用户。

请求方法：#

POST

字符编码：#

UTF-8

建议超时时间：#

回调策略#

当用户收到推送结果，并返回HTTP状态码为200时，表示推送成功；否则系统将进行最多20次推送。

回调参数#

放在HTTP Body中，采用Json格式，具体参数如下：

参数名	类型	参数说明	是否必返	规范
requestId	string	本次请求的唯一标识	是	请求唯一标识
code	int	请求返回码	是	详见接口响应码列表
message	string	请求返回描述，和请求返回码对应	是	详见接口响应码列表
statCode	int	回调状态码	否	状态码对应关系： 0 ：审核结果回调 1 ：流结束结果回调
contentType	int	用来区分音频和图片回调	否	可能取值如下： `1`：该回调为图片回调 `2`：该回调为音频回调
frameDetail	json_object	风险截帧信息	否	详见frameDetail说明
audioDetail	json_object	风险音频片段信息	否	详见audioDetail说明
tokenProfileLabels	json_array	账号属性标签	否	仅在开启功能时返回，详见tokenProfileLabels说明
tokenRiskLabels	json_array	账号风险标签	否	仅在开启功能时返回，详见tokenRiskLabels说明

其中，在图片回调时（contentType为`1`时），frameDetail每个成员的具体内容如下：

参数名	类型	参数说明	是否必返	规范
imgUrl	string	当前截帧的URL	否
riskLevel	string	当前截帧的处置建议	否	`PASS`：正常内容 `REVIEW`：可疑内容 `REJECT`：违规内容
riskLabel1	string	各个一级标签之间是并列的关系，当riskLevel为`PASS`时返回`normal`	否	一级标签
riskLabel2	string	二级标签归属于一级标签，当riskLevel为`PASS`时为空	否	二级标签
riskLabel3	string	三级标签归属于二级标签，当riskLevel为`PASS`时为空	否	三级标签
riskDescription	string	标签解释	否	对于命中用户自定义名单时返回：`命中自定义名单`；当riskLevel为`PASS`时返回:`正常`；其他情况展现形式为一级标签：二级标签：三级标签的中文名
riskDetail	json_object	风险详情信息	否	详见riskDetail说明
allLabels	json_array	全部的风险标签列表	否	详见allLabels说明
businessLabels	json_array	业务标签列表，传入imgBusinessType时返回	否	详见businessLabels说明
auxInfo	json_object	其他辅助信息	是	详见auxInfo说明

frameDetail中auxInfo的内容如下：

参数名	类型	参数说明	是否必返	规范
imgTime	float	截帧图片发生时间	否	视频流截帧图片违规发生的时间（绝对时间）
beginProcessTime	int	辅助参数	是	开始处理的时间（13位时间戳）
finishProcessTime	int	辅助参数	是	结束处理的时间（13位时间戳）
userId	int	声网用户账号标识	否	仅分流情况下存在，返回的userId是实际房间中的用户id，与请求参数中的uid无关。
strUserId	string	trtc流/volc流的用户id字段	否	分流的用户id（`TRTC`流和`VOLC`才会有）
detectType	int	用来区分截帧图片是否过了检测	否	可能取值如下：（仅当请求参数传了detectStep时才会返回该参数） `1`：截帧图片过了检测 2：截帧图片没过检测
room	string	房间号	否
similarityDedup	int	辅助参数	否	可能取值如下：（仅当相似帧去重推审功能生效时，外层处置建议从reject/review变更成pass返回该参数，其他情况不返回该字段） 1：值为1，相似帧去重推审功能生效

frameDetail中，riskDetail的内容如下：

参数名	类型	参数说明	是否必返	规范
riskSource	int	风险来源	是	可选值： `1000`：无风险 `1001`：文本风险 `1002`：视觉风险 `1003`：音频风险
faces	json_array	人脸信息	否	返回图片中涉政人物的名称及位置信息，详见faces说明
face_num	int	人脸数量	否
objects	json_array	物品信息	否	返回图片中标识或物品的名称及位置信息，详见objects说明
persons	json_array	人像信息	否
person_num	int	人像数量	否
ocrText	json_object	文字信息	否	返回图片中文字相关信息，详见ocrText说明

riskDetail中，faces数组每个成员的具体内容如下：

参数名	类型	参数说明	是否必返	规范
id	string	编号	是
name	string	人名	否
location	int_array	位置坐标	否	该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
probability	float	置信度	否	可选值在0～1之间，值越大，可信度越高
face_ratio	float	人脸占比	否

riskDetail中，objects数组每个成员的具体内容如下：

参数名	类型	参数说明	是否必返	规范
id	string	编号	是
name	string	名称	否
location	int_array	位置坐标	否	该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
probability	float	置信度	否	可选值在0～1之间，值越大，可信度越高
qrContent	string	二维码信息	否

riskDetail中，persons数组的每个元素的内容如下：

参数名	类型	参数说明	是否必返	规范
id	string	编号	是
location	int_array	位置坐标	否	该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
probability	float	置信度	否	可选值在0～1之间，值越大，可信度越高
person_ratio	float	人像占比	否

riskDetail中，ocrText数组每个成员的具体内容如下：

参数名	类型	参数说明	是否必返	规范
text	string	图片中识别出的文字	是	识别出来所有文字内容
matchedLists	json_array	命中的客户自定义名单信息	否	仅在命中客户自定义名单时返回，详见matchedLists说明
riskSegments	json_array	高风险内容片段	否	在启用涉政、暴恐、违禁、广告等功能时存在，详见riskSegments说明

ocrText中，matchedLists内每个元素详细内容如下：

参数名	类型	参数说明	是否必返	规范
name	string	客户自定义名单名称	是
words	json_array	命中的这个名单中的敏感词信息	是	下标从0开始计数，详见words说明

matchedLists中，words的每个元素详细内容如下：

参数名	类型	参数说明	是否必返	规范
word	string	敏感词	是
position	int_array	敏感词所在位置	是	下标从0开始计数

ocrText中，riskSegments的每个元素详细内容如下：

参数名	类型	参数说明	是否必返	规范
segment	string	高风险内容片段	否
position	int_array	高风险内容片段所在位置	否	下标从0开始计数

frameDetail中，allLabels数组的每个成员的内容如下：

参数名	类型	参数说明	是否必返	规范
riskLabel1	string	一级风险标签	是	一级风险标签
riskLabel2	string	二级风险标签	是	二级风险标签
riskLabel3	string	三级风险标签	是	三级风险标签
riskDescription	string	风险描述	是	格式为"一级风险标签：二级风险标签：三级风险标签"的中文名称对于命中用户自定义名单时返回：`命中自定义名单`
riskLevel	string	处置建议	是	`PASS`：正常内容 `REVIEW`：可疑内容 `REJECT`：违规内容
probability	float	置信度	是	可选值为0～1，值越大，可信度越高
riskDetail	json_object	风险详情	是	同frameDetail中的riskDetail结构一致

frameDetail中，businessLabels数组的每个成员的内容如下：

参数名	类型	参数说明	是否必返	规范
businessLabel1	string	一级标签	是	一级标签
businessLabel2	string	二级标签	是	二级标签
businessLabel3	string	三级标签	是	三级标签
businessDescription	string	标签描述	是	格式为"一级标签：二级标签：三级标签"的中文名称
confidenceLevel	int	置信等级	是	可选值在0～2之间，值越大，可信度越高
probability	float	置信度	是	可选值为0~1，值越大，可信度越高
businessDetail	Json_object	详细信息	是

businessLabels中，businessDetail的内容如下：

参数名	类型	参数说明	是否必返
faces	json_array	人脸信息	否
face_num	int	人脸数量	否
objects	json_array	物品信息	否
persons	Json_array	人像信息	否
person_num	int	人像数量	否

businessDetail中，faces数组的每个元素的内容如下：

参数名	类型	参数说明	是否必返	规范
id	string	编号	是
name	string	人名	否
location	int_array	位置坐标	否	该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
probability	float	置信度	否	可选值在0～1之间，值越大，可信度越高
face_ratio	float	人脸占比	否

businessDetail中，objects数组的每个元素的内容如下：

参数名	类型	参数说明	是否必返	规范
id	string	编号	是
name	string	名称	否
location	int_array	位置坐标	否	该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
probability	float	置信度	否	可选值在0～1之间，值越大，可信度越高

businessDetail中，persons数组的每个元素的内容如下：

参数名	类型	参数说明	是否必返	规范
id	string	编号	是
location	int_array	位置坐标	否	该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
probability	float	置信度	否	可选值在0～1之间，值越大，可信度越高
person_ratio	float	人像占比	否

其中，在音频回调时（contentType为2时），audioDetail每个成员的具体内容如下：

参数名	类型	参数说明	是否必返	规范
audioUrl	string	音频片段地址	是
riskLevel	string	当前事件的处置建议	是	`PASS`：正常内容 `REVIEW`：可疑内容 `REJECT`：违规内容
riskLabel1	string	各个一级标签之间是并列的关系，riskLevel为`PASS`时返回`normal`	是	一级标签
riskLabel2	string	二级标签归属于一级标签，当riskLevel为`PASS`时为空	是	二级标签
riskLabel3	string	三级标签归属于二级标签，当riskLevel为`PASS`时为空	是	三级标签
riskDescription	string	标签解释	是	格式为"一级风险标签：二级风险标签：三级风险标签"的中文名称对于命中用户自定义名单时返回：`命中自定义名单`
riskDetail	json_object	风险详情信息	是	详见riskDetail说明
allLabels	json_array	全部的风险标签列表	是	详见allLabels说明
businessLabels	json_array	业务标签列表，传入audioBusinessType时返回	否	详见businessLabels说明
auxInfo	json_object	其他辅助信息	是	详见auxInfo说明

audioDetail中auxInfo的内容如下：

参数名	类型	参数说明	是否必返	规范
beginProcessTime	int	辅助参数	是	开始处理的时间（13位时间戳）
finishProcessTime	int	辅助参数	是	结束处理的时间（13位时间戳）
audio_starttime	string	辅助参数	是	违规内容开始时间（绝对时间）
audio_endtime	string	辅助参数	是	违规内容结束时间（绝对时间）
userId	int	声网用户账号标识	否	仅分流情况下存在，返回的userId是实际房间中的用户id，与请求参数中的uid无关。
strUserId	string	trtc流/volc流的用户id字段	否	分流的用户id（`TRTC`流和`VOLC`才会有）
passThrough	json_object	透传字段	否	该字段内容与请求参数data中extra的passThrough的值相同
room	string	房间号	否

audioDetail中，riskDetail的详细内容如下：

参数名	类型	参数说明	是否必返	规范
riskSource	int	风险来源	是	风险来源，可选值： `1000`：无风险 `1001`：文本风险 `1002`：视觉风险 `1003`：音频风险
audioText	string	音频转译文本的结果	否
matchedLists	json_array	命中的客户自定义名单信息	否	命中客户自定义名单时返回，其他时不存在，详见matchedLists说明
riskSegments	json_array	高风险内容片段	否	在涉政、暴恐、违禁、竞品、广告法等功能的时候存在，详见riskSegments说明

riskDetail中，matchedLists的每个元素详细内容如下：

参数名	类型	参数说明	是否必返	规范
name	string	客户自定义名单名	是
words	json_array	命中的这个名单中的敏感词信息	是	下标从0开始计数，详见words说明

matchedLists中，words的每个元素详细内容如下：

参数名	类型	参数说明	是否必返	规范
word	string	敏感词	是
position	int_array	敏感词所在位置	是	下标从0开始计数

riskDetail中，riskSegments的每个元素详细内容如下：

参数名	类型	参数说明	是否必返	规范
segment	string	高风险内容片段	否
position	int_array	高风险内容片段所在位置	否	下标从0开始计数

audioDetail中，allLabels数组的每个成员的内容如下：

参数名	类型	参数说明	是否必返	规范
riskLabel1	string	一级风险标签	是	一级风险标签
riskLabel2	string	二级风险标签	是	二级风险标签
riskLabel3	string	三级风险标签	是	三级风险标签
riskDescription	string	风险描述	是	格式为"一级风险标签：二级风险标签：三级风险标签"的中文名称对于命中用户自定义名单时返回：`命中自定义名单`
riskLevel	string	处置建议	是	`PASS`：正常内容 `REVIEW`：可疑内容 `REJECT`：违规内容
probability	float	置信度	是	可选值为0～1，值越大，可信度越高
riskDetail	json_object	风险详情	是	同audioDetail中的riskDetail结构一致

audioDetail中，businessLabels数组的每个成员的内容如下：

参数名	类型	参数说明	是否必返	规范
businessLabel1	string	一级标签	是	一级标签
businessLabel2	string	二级标签	是	二级标签
businessLabel3	string	三级标签	是	三级标签
businessDescription	string	标签描述	是	格式为"一级标签：二级标签：三级标签"的中文名称
confidenceLevel	int	置信等级	是	可选值在0～2之间，值越大，可信度越高
probability	float	置信度	是	可选值为0~1，值越大，可信度越高
businessDetail	Json_object	详细信息	是

其中，tokenProfileLabels数组每个成员的具体内容如下：

参数名	类型	参数说明	是否必返	规范
label1	string	一级标签	否
label2	string	二级标签	否
label3	string	三级标签	否
description	string	标签描述	否
timestamp	int	打标签时间戳	否	13位Unix时间戳，单位：毫秒

其中，tokenRiskLabels数组每个成员的具体字段同tokenProfileLabels

审核结束回调参数（returnFinishInfo为1时返回）：#

参数名	类型	参数说明	是否必返	规范
code	int	请求返回码	是	详见接口响应码列表
message	string	请求返回描述，和请求返回码对应	是	详见接口响应码列表
requestId	string	请求唯一标识	是
statCode	int	回调状态码	是	回调状态码，当returnFinishInfo为true时存在。状态码对应关系： 0 ：审核结果回调 1 ：流结束结果回调当statCode=1时，如下参数存在
contentType	int	⽤来区分⾳频和图⽚回调，当code等于1100时返回	是	可能取值如下： `1`：该回调为图片回调 `2`：该回调为音频回调
riskLevel	string	流风险处置建议	是	回调结束时返回整体流的处置建议
pullStreamSuccess	bool	拉流是否成功	是	可能取值如下： `true`：拉流成功 `false`：拉流失败如果一张截图都没有获取成功即认为拉流失败
detail	json_object	结果详情	是	详见detail说明
auxinfo	json_object	辅助信息	是	详见auxinfo说明

结束回调中的detail内容如下：

参数名	类型	参数说明	是否必返	规范
requestParams	json_object	返回请求参数data中的所有字段	是	无

其中auxInfo字段结构如下：

参数名	类型	参数说明	是否必返	规范
errorCode	int	状态码	是	状态码 3001：流地址访问失败，例如资源HTTP状态码404、403 3002：流数据无效，例如“Invalid data found when processing input” 3003：流不存在，例如zego返回197612错误码 3004：流未返回音频数据 3005：拉流token无效或过期，建议使用新token重新开启审核，例如声网token过期或者trtc usersig无效
streamTime	int	流审核时长	否	流结束后最后一次返回，代表送审时长，如有间隔审核逻辑时，和流真实时长可能不一致

参数名

类型

参数说明

是否必返

规范

errorCode

int

状态码

是

状态码

3001：流地址访问失败，例如资源HTTP状态码404、403

3002：流数据无效，例如“Invalid data found when processing input”

3003：流不存在，例如zego返回197612错误码

3004：流未返回音频数据

3005：拉流token无效或过期，建议使用新token重新开启审核，例如声网token过期或者trtc usersig无效

streamTime

int

流审核时长

否

流结束后最后一次返回，代表送审时长，如有间隔审核逻辑时，和流真实时长可能不一致

视频流关闭接口#

接口描述#

该接口用于客户端通知服务端某个视频流已关闭。

请求URL：#

集群	URL	支持产品列表
上海	`http://api-videostream-sh.fengkongcloud.com/finish_videostream/v4`	中文视频流
新加坡	`http://api-videostream-xjp.fengkongcloud.com/finish_videostream/v4`	中文视频流英语视频流阿语视频流
硅谷	`http://api-videostream-gg.fengkongcloud.com/finish_videostream/v4`	中文视频流英语视频流阿语视频流
印度	`http://api-videostream-yd.fengkongcloud.com/finish_videostream/v4`	中文视频流

请求方法：#

POST

支持协议：#

HTTP或HTTPS

字符编码：#

UTF-8

建议超时时间：#

请求参数：#

放在HTTP Body中，采用Json格式，具体参数如下：

请求参数名	类型	参数说明	传入说明	规范
accessKey	string	公司密钥	必传参数	用于权限认证，开通账号服务时由数美提供
requestId	string	本次请求的唯一标识	必传参数	需要关闭视频流的requestId

返回参数#

放在HTTP Body中，采用Json格式，具体参数如下：

返回结果参数名	参数类型	参数说明	是否必返	规范
requestId	string	本次请求的唯一标识	是	请求唯一标识
code	int	请求返回码	是	请见接口响应码列表
message	string	请求返回描述，和请求返回码对应	是	请见接口响应码列表

imgBusinessType可选值列表#

业务标签识别类型	类型说明	备注
AGE	人脸 - 年龄	可识别未成年人
GENDER	人脸 -性别
BEAUTY	人脸 - 颜值
FACEDETECTION	人脸-人脸检测	如识别无人脸、真人、口罩人脸、正脸、侧脸等
FAKEFACE	人脸 - 伪造人脸
RACE	人脸-人种	如黑种人、白种人、黄种人
PUBLICFIGURE	人物 - 公众人物	如识别知名明星、网红等
TAINTEDSTAR	人物 - 劣迹人物
POSTURE	人像-人像姿态	如识别坐姿、跪姿等
DRESS	人像 - 人像穿着	如识别jk、汉服等
BODY	人体	如识别头发、眼睛、鼻子等
PICTUREFORM	画面属性 - 画面类型	如识别动漫、表情包等
PICTURESTRUCT	画面属性-画面结构	如识别宫格图、桥段图等
LOWVISION	画面属性 - 画面低质	如识别模糊、涂抹、马赛克等
LOWCONTNET	画面属性 - 内容低质	如识别点线密集、虫类密集等
LIVEPICTURE	画面属性-直播画面	如识别床上直播、开车直播等
SCREENSHOT	画面属性 - APP截图（内容搬运）	如识别朋友圈截图、聊天截图等
FITNESS	场景主题-健身
CATE	场景主题-美食
MUSIC	场景主题-音乐
SPORTS	场景主题-体育
SCENERY	场景主题-自然风光	如识别天空、大海、草原等
CITYVIEW	场景主题-城市风光	如识别街景
3CPRODUCTSLOGO	LOGO - 3C电子类品牌	如识别华为、小米、OPPO等LOGO
SHOPPINGAPPSLOGO	LOGO - 购物比价类应用	如识别拼多多等LOGO
RETOUCHAPPSLOGO	LOGO - 拍摄美化类应用	如识别快剪辑、秒拍等LOGO
SOCIALAPPSLOGO	LOGO - 社交通讯类应用	如识别微博、小红书等LOGO
PHOTOMATERIALLOGO	LOGO - 素材版权类应用	如识别CFP等LOGO
NEWSAPPSLOGO	LOGO - 新闻阅读类应用	如识别新浪、视觉中国等LOGO
ENTERTAINMENTAPPSLOGO	LOGO - 影音娱乐类应用	如识别抖音、快手等LOGO
SPORTSLOGO	LOGO - 体育赛事	如识别奥运会等LOGO
APPARELLOGO	LOGO - 鞋帽服饰类品牌	如识别VANS、H&M等LOGO
ACCESSORIESLOGO	LOGO - 饰品首饰类品牌	如识别AudemarsPiguet、Nomos等LOGO
COSMETICSLOGO	LOGO - 化妆品类品牌	如识别LOTTE、EyesLipsFace等LOGO
FOODLOGO	LOGO - 食品类品牌	如识别Starbucks、LOTTE等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	场所	如识别卫生间、酒店、厨房等

接口响应码列表#

code请求返回码列表如下：

code	message
1100	成功
1901	QPS超限
1902	参数不合法
1903	服务失败
1907	获取视频长度超时
9100	余额不足
9101	无权限操作

示例#

上传接口请求示例#

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

上传接口返回示例：#

{
    "code":1100,
    "message":"正常",
    "requestId":"d05f4270374ca516ce7aafc0139afd25"
}

异步回调结果示例：#

截帧图片回调

{
    "code": 1100,
    "contentType": 1,
    "message": "成功",
    "requestId": "1639825145166_vs130_1639825248361471656",
    "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"
    },
    "auxInfo": {
        "passThrough": {
            "passThrough1": "111",
            "passThrough2": "222",
            "passThrough3": "333"
        }
    }
}

音频回调

{
    "requestId":"y28f8a4f1264085b321f12223wqed1121retestpvvvvv44321we12_3",
    "code":1100,
    "message":"成功",
    "contentType":2,
    "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"
    },
    "requestParams":{
        "dedup":"room",
        "eventId":"nickname",
        "isVideoNewStream":true,
        "returnAlltext":1,
        "returnFinishInfo":1,
        "returnPreAudio":1,
        "returnPreText":1,
        "role":"USER",
        "room":"y1123413312ewe24sv2",
        "streamType":"DEFAULT",
        "tokenId":"tokenzyp",
        "url":"rtmp://10.141.3.139:1936/live/stream"
    },
    "statCode":0
}

关闭接口请求示例：#

{
    "accessKey": "4Ky6AV4hE0pWLeG1bXNw",
    "requestId": "1639825145166"
}

关闭接口返回示例#

{
    "code":1100,
    "message":"成功",
    "requestId":" a78eef377079acc6cdec24967ecde722"
}