请求参数#

请求url#

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

请求方法#

POST

字符编码#

UTF-8

建议超时时间#

1s

请求参数#

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

参数名称类型是否必选说明
accessKeystringY公司密钥
用于权限认证,开通账号服务时由数美提供
typestringY需要识别的违规类型,可选值:
涉政识别:POLITICAL
色情识别:PORN
广告识别:AD
娇喘识别:MOAN
唱歌识别:SING
国歌识别:ANTHEN
语种识别:LANGUAGE
如需做组合识别,通过下划线连接即可,如 AD_PORN_POLITICAL 用于广告、色情和涉政识别
默认取值:DEFAULT等价于POLITICAL_PORN_MOAN
btIdstringN音频流唯一请求标识
用于查询指定音频,限长128位字符
appIdstringN应用标识
用于区分相同公司的不同应用,该参数传递值可与数美服务协商用于区分应用
默认应用值:default
callbackstringY异步检测结果回调通知您的URL
支持HTTP和HTTPS
datajson_objectY请求数据内容,最长1MB

其中,data的内容如下:

参数名称类型是否必选说明
urlstringY要检测的音频流url地址
audioNamestringN音频名称
用于后台界面展示,建议传入
roomstringN直播房间号
returnAllTextboolN可取值:
true:返回所有音频片段识别结果
每10秒一个音频片段
false:返回风险片段(riskLevel为REJECTREVIEW)识别结果
默认为false
returnPreTextboolN可取值:
true:返回的content字段包含违规音频前一分钟文本内容
false:返回的content字段只包含违规音频片段文本内容
默认值为false
returnPreAudioboolN可取值:
true返回违规音频前一分钟音频链接
false只返回违规片段音频链接
默认值为false
tokenIdstringY客户端用户账号唯一标识
用于用户行为分析,建议传入用户UID
channelstringN数据场景
取值需要与数美协商

请求示例#

{
"accessKey":"xxx",
"type":"POLITICAL_PORN_MOAN_ABUSE_AD",
"data":{
"url":"http://ivi.bupt.edu.cn/hls/cctv1hd.m3u8",
"audioName":"xxxxxx",
"room":"xxxxxx",
"tokenId":"123",
"returnAllText":true,
"returnPreAudio":true,
"returnPreText":true,
"channel":"xxxxxx",
"ip":"xxxxxx",
},
"btId":"khjfgjud9swsss",
"callback":"http://xxxxx",
}

即构请求参数#

请求url#

  • 北京:

http://api-audiostream-bj.fengkongcloud.com/v2/saas/anti_fraud/audiostream

  • 上海:

http://api-audiostream-sh.fengkongcloud.com/v2/saas/anti_fraud/audiostream

请求方法#

POST

字符编码#

UTF-8

建议超时时间#

3s

请求参数#

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

参数名称类型是否必选说明
accessKeystringY公司密钥
用于权限认证,开通账号服务时由数美提供
typestringYN需要识别的违规类型,可选值:
涉政识别:POLITICAL
色情识别:PORN
广告识别:AD
娇喘识别:MOAN
唱歌识别:SING
国歌识别:ANTHEN
如需做组合识别,通过下划线连接即可,如 AD_PORN_POLITICAL 用于广告、色情和涉政识别
默认取值:DEFAULT等价于POLITICAL_PORN_MOAN
btIdstringN音频流唯一请求标识
用于查询指定音频,限长128位字符
appIdstringN应用标识
用于区分相同公司的不同应用,该参数传递值可与数美服务协商用于区分应用
默认应用值:default
callbackstringY异步检测结果回调通知您的URL
支持HTTP和HTTPS
datajson_objectY请求数据内容,最长1MB

其中,data的内容如下:

参数名称类型是否必选说明
streamTypestringY流类型: 需要指定为ZEGO
zegoParamjson_objectY要检测的流参数
audioNamestringN音频名称
用于后台界面展示,建议传入
roomstringN房间号
returnAllTextboolN可取值:
true:返回所有音频片段识别结果
每10秒一个音频片段
false:返回风险片段(riskLevel为REJECTREVIEW)识别结果
默认为false
returnPreTextboolN可取值:
true:返回的content字段包含违规音频前一分钟文本内容
false:返回的content字段只包含违规音频片段文本内容
默认值为false
returnPreAudioboolN可取值:
true返回违规音频前一分钟音频链接
false只返回违规片段音频链接
默认值为false
tokenIdstringY客户端用户账号唯一标识
用于用户行为分析,最长40字节
分流场景(按streamId录制)下建议传入
合流场景(按roomId录制)下可以取值为空字符串
channelstringN见渠道配置表

zegoParam内容如下:

参数名称类型是否必选说明
tokenIdstringYzego提供的身份验证信息,用于token登录
streamIdstringY用户设置的音频流编号
唯一对应一路音频流
streamId与roomId至少存在其中之一
如果streamId与roomId同时存在时,streamId有效
当streamId生效时,服务端以用户为单位拉流
roomIdstringY用户设置的房间编号
唯一对应一个房间
streamId与roomId至少存在其中之一
如果streamId与roomId同时存在时,streamId有效
当roomId生效时,服务端以房间为单位拉流
testEnvboolY是否使用zego测试环境,可取值为
true:测试环境
false:正式环境
默认为false

请求示例#

{
"appId":"default",
"accessKey":"xxxxxxxxxxx",
"type":"DEFAULT",
"btId":"aaaa",
"data":{
"tokenId":"test",
"room":"test123",
"channel":"AUDIO",
"returnAllText":true,
"streamType":"ZEGO",
"zegoParam":{
"tokenId":"token_zego",
"streamId":"222"
}
},
"callback":"http://xxxxxx"
}

声网请求参数#

请求url#

  • 北京:

http://api-audiostream-bj.fengkongcloud.com/v2/saas/anti_fraud/audiostream

  • 上海:

http://api-audiostream-sh.fengkongcloud.com/v2/saas/anti_fraud/audiostream

请求方法#

POST

字符编码#

UTF-8

建议超时时间#

3s

请求参数#

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

参数名称类型是否必选说明
accessKeystringY公司密钥
用于权限认证,开通账号服务时由数美提供
typestringYN需要识别的违规类型,可选值:
涉政识别:POLITICAL
色情识别:PORN
广告识别:AD
娇喘识别:MOAN
唱歌识别:SING
国歌识别:ANTHEN
如需做组合识别,通过下划线连接即可,如 AD_PORN_POLITICAL 用于广告、色情和涉政识别
默认取值:DEFAULT等价于POLITICAL_PORN_MOAN
btIdstringN音频流唯一请求标识
用于查询指定音频,限长128位字符
appIdstringN应用标识
用于区分相同公司的不同应用,该参数传递值可与数美服务协商用于区分应用
默认应用值:default
callbackstringY异步检测结果回调通知您的URL
支持HTTP和HTTPS
datajson_objectY请求数据内容,最长1MB

其中,data的内容如下:

参数名称类型是否必选说明
streamTypestringY流类型: 需要指定为AGORA
agoraParamjson_objectY要检测的流参数
audioNamestringN音频名称
用于后台界面展示,建议传入
roomstringN房间号
returnAllTextboolN可取值:
true:返回所有音频片段识别结果
每10秒一个音频片段
false:返回风险片段(riskLevel为REJECTREVIEW)识别结果
默认为false
returnPreTextboolN可取值:
true:返回的content字段包含违规音频前一分钟文本内容
false:返回的content字段只包含违规音频片段文本内容
默认值为false
returnPreAudioboolN可取值:
true返回违规音频前一分钟音频链接
false只返回违规片段音频链接
默认值为false
tokenIdstringY客户端用户账号唯一标识
用于用户行为分析,最长40字节
分流场景(按streamId录制)下建议传入
合流场景(按roomId录制)下可以取值为空字符串
channelstringN见渠道配置表

agoraParam内容如下:

参数名称类型是否必选说明
appIdstringY声网提供的appId
注意与数美的appId区分开
channelstringY声网提供的频道名
注意与数美channel区分开
tokenstringN安全要求较高的用户可以使用 Token进行认证
生成方式详见声网文档: https://docs.agora.io/cn/Recording/token_server?platform=CPP
uidintN用户 ID
32 位无符号整数
当token存在时,必须提供生成token时所使用的用户ID。注意
此处需要区别实际房间中的用户uid,提供给服务端录制所用的uid不允许在房间中存在
isMixingEnabledboolN单流/合流录制
true:合流,合流是指一个直播房间一路流
false:分流,分流是指一个麦位一路流
默认合流录制
channelProfileintN声网录制的频道模式,取值:
0:通信(默认)
即常见的 1 对 1 单聊或群聊,频道内任何用户可以自由说话
1:直播
有两种用户角色:主播和观众
默认以通信模式录制,即默认值为0

请求示例#

{
"accessKey":"XXXXXXXXXXXXXXX",
"type":"PORN_AD_POLITICAL_MOAN_ABUSE",
"data":{
"tokenId":"username1",
"room":"1563943943.16",
"returnPreAudio":true,
"returnAllText":true,
"returnPreText":true,
"streamType":"AGORA",
"agoraParam":{
"appId":"2980dcb5f71b40e8bd83397ec2099bee",
"channelKey":"00422304bd81b0d384d4110f173742fdc46178bbaf22980dcb5f71b40e8bd83397ec2099bee1563943943800000010000000000",
"uid":2019072412,
"channel":"AUDIO",
"isMixingEnabled":false
}
},
"callback":"http://xxxxxxxxxxx/",
"tokenId":"username2",
"btId":"agora",
"callbackParam":{
"test1":1,
"test2":"qew",
"test3":true
}
}