accessKey | string | 公司密钥 | 是 | 由数美提供,具体内容见邮件 |
appId | string | 应用标识 | 是 | 用于区分应用
需要联系数美服务开通,请使用数美单独提供的传值为准
,默认内容见邮件 |
eventId | string | 事件标识 | 是 | 区分场景数据
需要联系数美服务开通,请使用数美单独提供的传值为准
,默认内容见邮件 |
type | string | 检测的风险类型 | businesstype和type必传其一 | 可选值:监管功能
POLITY:涉政识别
EROTIC:色情识别
ADVERT:广告识别
BAN:违禁识别
VIOLENT:暴恐识别
MOAN:娇喘识别
AUDIOPOLITICAL:一号领导人声纹识别
ANTHEN:国歌识别
DIRTY:辱骂识别
ADLAW:广告法识别
SING:唱歌识别
MINOR:未成年人识别
BANEDAUDIO:违禁歌曲
COPYRIGHTSONGS:版权歌曲
VOICE:人声属性(伪造人声)
如需做组合识别,通过下划线连接即可,例如POLITY_EROTIC_MOAN
涉政、色情和娇喘识别,涉政、色情、辱骂、广告识别指的是语义内容的风险检测 |
businessType | string | 业务标签 | businesstype和type必传其一 | 可选值:业务标签的一、二、三级标签
GENDER:性别识别
AGE:年龄识别
TIMBRE:音色识别
SING:唱歌识别
LANGUAGE:语种识别
VOICE:人声属性
AUDIOSCENE:声音场景
如需识别音色、唱歌、语种GENDER必传 |
data | json_object | 请求的数据内容 | 是 | 本次请求相关信息,最长1MB |
tokenId | string | 用户账号标识 | 是 | 用于区分用户账号,建议传入用户ID |
btId | string | 音频唯一标识 | 是 | 用于查询指定音频,限长128位字符 |
streamType | string | 流类型 | 是 | 可选值:
NORMAL:普通流地址,目前支持rtmp、rtmps、hls、http、https协议,支持flv,m3u8等格式
ZEGO:即构
AGORA:声网
TRTC:腾讯录制
VOLC:火山引擎录制
GIN:巨人录制
ALI:阿里录制
注意:使用RTC的SDK录制方案时,会在RTC侧产生额外录制费用,具体请咨询相关厂商 |
url | string | 直播流地址 | 否 | 当streamType为NORMAL时必传 |
lang | string | 音频流语言类型 | 否 | 可选值(默认zh):
zh:中文
en:英文
ar:阿拉伯语
hi:印地语
es:西班牙语
fr:法语
ru:俄语
pt:葡萄牙语
id:印尼语
de:德语
ja:日语
tr:土耳其语
vi:越南语
it:意大利语
th:泰语
tl:菲律宾语
ko:韩语
ms:马来语
[集群支持语种详见 请求URL支持语种](#language) |
zegoParam | json_object | 要检测的流参数 | 否 | 当streamType为ZEGO时必传 |
tokenId | string | 身份验证信息 | 是 | 获取zego的identify_token用于登录,生成方式详见zego文档:https://doc-zh.zego.im/article/15258。注意tokenId唯一标识审核请求,每次请求都需要重新生成。 |
streamId | string | 音频流编号 | 否 | 音频流编号,唯一对应一路音频流,streamId与roomId至少传入其中之一。 |
roomId | string | 房间编号 | 否 | 唯一对应一个房间。 |
isMixingEnabled | bool | 录制模式 | 否 | 录制模式
true:合流,房间内所有用户合成一路流录制审核。此时如果streamId与roomId单独存在时则单独生效;但当streamId与roomId同时存在时,则以streamId为有效值。
false:分流,房间内每个用户单独录制审核。此时roomId为必传,且以roomId为有效值。同时streamId不可以传入。 |
initDomain | int | 即构SDK初始化是否有设置隔离域名 | 否 | 当即构客户端init初始化支持隔离域名和随机userId该字段必传
可选值:
0:默认版本
1:仅支持客户端初始化有隔离域名
2:支持客户端初始化有隔离域名和随机userId功能
3:更新SDK,修复一些bug
4:支持客户自定义传入SEI信息
5:支持vad静音检测,token会有唯一性校验,每次上传鉴黄必须重新生成
6:房间维度拉流送审模式下,开发者可以控制某条流是否需要送审
推荐使用6进行接入;默认值为0 |
trtcParam | json_object | 腾讯录制参数 | 否 | 当streamType为TRTC时必传,详见扩展参数 |
sdkAppId | int | | 是 | 腾讯提供的sdkAppId |
demoSences | int | | 是 | 录制类型可选值:分流录制:2;合流录制:4 |
userId | string | | 是 | 分配给录制端的userId,限制长度为32bit,只允许包含(a-zA-Z),数字(0-9)以及下划线和连词符 |
uid | string | | 否 | 指定需要审核的用户ID,如果不传该参数,则默认拉取并审核房间中所有推流用户的流。如果需要审核同一房间内的一部分用户,请使用不同的录制端userId和userSig分多次请求。注意区分此参数和userId的区别。 |
userSig | string | | 是 | 录制userId对应的验证签名,相当于登录密码 |
roomId | int | | 是 | 房间号码,取值范围:1-4294967294。roomId与strRoomId必传一个,若两者都有值优先选用roomId |
strRoomId | string | | 是 | 房间号码,取值说明:只允许包含(a-zA-Z),数字(0-9)以及下划线和连词符。若您选用strRoomId时,需注意strRoomId和roomId两者都有值优先选用roomId |
agoraParam | json_object | 声网流参数 | 否 | 当streamType为AGORA时必传,详见agoraParam参数 |
appId | string | 声网提供的appId | 是 | 注意与数美的appId区分开 |
channel | string | 声网提供的频道名 | 是 | |
token | string | | 否 | 安全要求较高的用户可以使用token进行认证,生成方式详见声网文档:https://docs.agora.io/cn/Recording/token_server?platform=CPP。建议将token的有效期设置超过频道的持续时间,防止token失效导致无法拉流。当前声网支持的最大token有效期为24小时,因此当频道持续时间超过24小时的时候,需要处理token失效的问题。处理方法:在请求参数中设置开启音频流结束回调通知(设置returnFinishInfo为1)。当回调接收到审核结束通知(statCode为1),并且原因是由于拉流的token无效或过期(auxInfo下errorCode状态码返回3005),如果频道仍然存在并且需要继续审核,则生成新的token,将频道重新送审。 |
uid | int | 用户ID | 否 | 32位无符号整数,当token存在时,必须提供生成token时所使用的用户ID。注意,此处需要区别实际房间中的用户uid,提供给服务端录制所用的uid不允许在房间中存在 |
isMixingEnabled | bool | 单流/合流录制。 | 否 | 默认值为true。true: 合流;false: 分流。合流是指一个直播房间一路流;分流是指一个麦位一路流。 |
channelProfile | int | 声网录制的频道模式 | 否 | 通信,常见的1对1单聊或群聊,频道内任何用户可以自由说话;直播,有两种用户角色:主播和观众,可选值如下(默认值为0):0: 通信;1: 直播 |
subscribeMode | string | 订阅模式 | 否 | AUTO: 自动订阅房间内的所有流,不设置subscribeMode时候的默认行为;UNTRUSTED: 配合untrustedUserIdList只订阅该列表指定的用户流,仅在声网分流里生效;TRUSTED: 配合trustedUserIdList只订阅该列表以外的用户流,仅在声网分流中生效 |
trustedUserIdList | string_array | 信任用户的列表 | 否 | subscribeMode=TRUSTED时生效,允许为空,数美不会订阅房间内该列表指定的用户流。其中每个元素uid的范围应为uint32的范围,但类型为string。例如:["123","456"] |
untrustedUserIdList | string_array | 非信任用户的列表 | 否 | subscribeMode=UNTRUSTED时生效,不允许为空,数美只订阅房间内该列表指定的用户流。其中每个元素uid的范围应为uint32的范围,但类型为string。例如:["123","456"] |
volcParam | json_object | 火山流参数 | 否 | 当streamType为VOLC时必传,详见volcParam参数 |
appId | string | 火山引擎提供的appId | 是 | 注意与数美的appId区分开 |
roomId | string | 房间号 | 是 | |
token | string | 火山引擎token | 是 | 详见:https://www.volcengine.com/docs/6348/70121 |
userId | string | | 是 | 分配给录制端的userId |
subscribeMode | string | 订阅模式 | 否 | AUTO: 自动订阅房间内的所有流,不设置subscribeMode时候的默认行为。
UNTRUSTED: 配合untrustedUserIdList只订阅该列表指定的用户流,此种模式下如果untrustedUserIdList列表为空,参数错误,因为无法订阅任何流。
TRUSTED: 配合trustedUserIdList只订阅该列表以外的用户流,此种模式下如果一定时间下没有untrustedUserIdList名单外的用户进入房间,数美将主动结束审核。 |
trustedUserIdList | string_array | 信任用户的列表 | 否 | subscribeMode=TRUSTED时生效,允许为空,数美不会订阅房间内该列表指定的用户流。 |
untrustedUserIdList | string_array | 非信任用户的列表 | 否 | subscribeMode=UNTRUSTED时生效,不允许为空,数美只订阅房间内该列表指定的用户流。 |
ginParam | json_object | 巨人流参数 | 否 | 当streamType为GIN时必传,详见ginParam参数 |
tokenId | string | 房间token | 是 | 用于拉流端登陆房间,需要巨人提供 |
roomId | string | 房间编号 | 是 | 唯一对应一个房间,服务端以房间为单位拉流录制 |
isMixingEnabled | bool | 单流/合流录制。 | 否 | 默认值为true。true: 合流;false: 分流,合流是指房间内所有用户合成一路流录制审核;分流是指房间内每个用户单独录制审核. |
ip | string | 指定服务器ip | 是 | |
port | string | 指定端口 | 是 | |
aliParam | json_object | 阿里流参数 | 否 | 当streamType为ALI时必传 |
token | string | 鉴权 | 是 | 用于拉流端加入频道,生成方式详见文档:https://help.aliyun.com/zh/live/user-guide/token-based-authentication,每次上传审核都需要重新生成新的token。 |
room | string | 房间ID | 是 | 必传参数,非空字符串,需要和生成token使用的channelID完全一致。服务端以房间为单位拉流录制。room为唯一标志,相同的room不会重复拉流。 |
userId | string | 拉流机器人ID,。 | 是 | 需要和生成token的userId完全一致,必传参数,非空字符串 |
isMixingEnabled | bool | 录制模式。 | 否 | 默认值为true。true: 合流;false: 分流。true:合流,房间内所有用户合成一路流录制审核;false:分流,房间内每个用户单独录制审核。 |
returnPreText | int | 是否返回违规音频流片段的前文文字信息 | 否 | 可选值:0(默认):不返回违规片段前文;1:返回违规片段前文 |
returnPreAudio | int | 是否返回违规音频流片段的前文音频链接 | 否 | 可选值:0(默认):不返回违规片段前文音频;1:返回违规片段前文音频 |
returnFinishInfo | int | 音频流结束回调通知 | 否 | 可选值:0(默认):审核结束时不发送结束通知;
1:审核结束时发起结束通知,回调参数增加statCode状态码
建议传入1(默认值为0,在流结束时不会产生回调) |
returnAllText | int | 返回音频片段的等级 | 否 | 可选值如下(默认为0):
0:返回风险等级为非pass的音频片段
1:返回所有风险等级的音频片段 建议传入1 (默认为0,在静音的情况下不会产生回调) |
extra | json_object | 辅助参数 | 否 | 用于辅助音频检测的相关信息 |
passThrough | json_object | 透传字段 | 否 | 该字段内容会随着回调结果一起返回 |
liveTitle | string | 标题 | 否 | 房间标题(人审服务时传入) |
anchorName | string | 昵称 | 否 | 用户昵称(人审服务时传入) |
audioDetectStep | int | 抽帧审核步长 | 否 | 取值范围1-36,默认每片段均审核;设置1审核奇数片段,2审核每三片段一次,以此类推 |
receiveTokenId | string | 消息接收者tokenId(私聊场景) | 否 | 由字母、数字、下划线、短杠组成,长度≤64字符 |
deviceId | string | 数美设备标识 | 否 | |
ip | string | 用户公网IP地址 | 否 | 支持IPv4或IPv6 |
level | int | 用户等级 | 否 | 0:最低级(新注册/不活跃用户);1:较低级;2:中等级;3:较高级;4:最高级(VIP/付费用户) |
gender | string | 用户性别 | 否 | 可选值:male(男性),female(女性) |
callback | string | 回调地址 | 是 | 异步检测结果回调通知您的URL,支持HTTP和HTTPS |
acceptLang | string | 返回标签的语种类型 | 否 | 选择返回标签的语种类型
可选值:
zh:中文
en:英文
不传入默认为返回中文标签 |