请求参数#

请求url#

  • 北京:http://api-videostream-bj.fengkongcloud.com/v3/saas/anti_fraud/videostream
  • 上海:http://api-videostream-sh.fengkongcloud.com/v3/saas/anti_fraud/videostream

请求方法#

POST

字符编码#

UTF-8

建议超时时间#

3s

请求参数#

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

参数名称类型是否必选说明
accessKeystringY公司密钥
用于权限认证,开通账号服务时由数美提供
appIdstringN应用标识,用于区分相同公司的不同应用,该参数传递值可与数美服务协商用于区分应用
默认应用值:default
imgTypestringY视频流截帧识别类型,可选值:
涉政识别:POLITICS
色情识别:PORN
广告识别:AD
视频水印logo识别:LOGO
不良场景识别:BEHAVIOR
支持吸烟、喝酒、赌博、吸毒、避孕套和无意义画面
如需做组合识别,通过下划线连接即可,如
POLITICS_PORN_AD用于广告、色情和涉政识别
默认值:DEFAULT
默认识别涉政、色情、广告,等价于POLITICS_PORN_AD
注意这里POLITICS实际识别内容为涉政人物和暴恐
audioTypestringN视频流中的音频流识别类型,可选值:
涉政识别:POLITICAL
色情识别:PORN
广告识别:AD
娇喘识别:MOAN
唱歌识别:SING
语种识别:LANGUAGE
不需要识别音频:NONE
如需做组合识别,通过下划线连接即可,如
POLITICAL_PORN_MOAN用于广告、色情和涉政识别
默认值:DEFAULT
默认识别涉政、色情、广告,等价于POLITICS_PORN_AD
imgCallbackstringY图片回调地址
将视频流中截帧图片的检测结果通过该地址回调给用户
audioCallbackstringN音频回调地址
将视频流中音频的检测结果通过该地址回调给用户
audioType值不为NONE时必传
datajson_objectY请求数据内容,最长1MB

其中,data的内容如下:

参数名称类型是否必选说明
streamTypestringY可选值为:
NORMAL:普通流地址,目前仅支持rtmp协议
AGORA:目前仅支持声网分流录制模式
tokenIdstringY客户端用户账号唯一标识
用于用户行为分析,建议传入用户UID,最长40位
urlstringN要检测的视频流url地址
目前仅支持rtmp协议
当streamType为NORMAL时必传
agoraParamjson_objectN要检测的声网流参数
当streamType为AGORA时必传
returnAllImgintN用户可根据需求选择返回不同审核结果的图片,可选值为:
0:回调reject、review结果的图片审核信息
1:回调所有结果的图片审核信息
默认值为0
streamNamestringN视频流名称
用于后台界面展示,建议传入
returnAllTextboolN可取值:
true:返回所有音频片段识别结果
每10秒一个音频片段
false:返回风险片段(riskLevel为REJECTREVIEW)识别结果
默认为false
returnPreTextboolN可取值:
true:返回的content字段包含违规音频前一分钟文本内容
false:返回的content字段只包含违规音频片段文本内容
默认值为false
returnPreAudioboolN可取值:
true返回违规音频前一分钟音频链接
false只返回违规片段音频链接
默认值为false
detectFrequencyfloatN视频流截帧频率
取值范围:1-60(秒/帧)
默认为3
detectStepintN视频流截帧图片检测步长
已截帧图片每个步长只会检测一次
取值大于等于1
channelstringN数据场景
取值需要与数美协商
roomstringN直播间/游戏房间编号
可针对单个房间制定不同的策略
使用声网协议的用户建议传入

agoraParam内容如下:

参数名称类型是否必选说明
appIdstringY声网提供的应用标识
channelstringY声网提供的频道名
channelProfileintN声网录制的频道模式,取值:
0:通信(默认)
即常见的 1 对 1 单聊或群聊,频道内任何用户可以自由说话
1:直播
有两种用户角色:主播和观众
默认以通信模式录制,即默认值为0
channelKeystringN安全要求较高的用户可以使用 ChannelKey
获取方式详见声网文档ChannelKey生成方式https://docs.agora.io/cn/Recording/token
uidintN用户 ID
32 位无符号整数
当channelKey存在时,必须提供生成channelKey时所使用的用户ID
注意,此处需要区别实际房间中的用户uid,提供给服务端录制所用的uid不允许在房间中存在

请求示例#

RTMP视频流请求示例

{
"accessKey":"xxx",
"audioCallback":"http://xxx",
"audioType":"PORN",
"data":{
"channel":"VIDEOSTREAM",
"detectFrequency":3,
"returnAllImg":1,
"returnAllText":true,
"returnPreAudio":true,
"returnPreText":true,
"room":"001",
"streamType":"NORMAL",
"tokenId":"1157893895",
"url":"rtmp://xxxx"
},
"imgCallback":"http://xxxxx",
"imgType":"DEFAULT"
}

声网视频流请求示例

{
"accessKey":"xxx",
"audioCallback":"http://xxx/",
"audioType":"AD",
"data":{
"agoraParam":{
"appId":"xxx",
"channel":"letdo",
"channelKey":"xxxx",
"uid":654321
},
"channel":"VIDEOSTREAM",
"detectFrequency":3,
"returnAllImg":1,
"returnAllText":true,
"returnPreAudio":true,
"returnPreText":true,
"room":"001",
"streamName":"test1",
"streamType":"AGORA",
"tokenId":"1157893895"
},
"imgCallback":"http://xxxx",
"imgType":"DEFAULT"
}