审核任务管理
手动管理音视频内容审核任务。您根据自己的业务场景,按需对某些通话、或通话的某些业务阶段进行审核。
开通服务
内容审核为付费增值服务。可登录控制台,IM & 音视频审核页面开通音视频审核服务。
在使用内容审核任务管理 API 之前,请确认已在控制台开通音视频审核服务,并已完成相关配置。请注意,音视频审核的触发模式需要配置为手动才能使用 API 控制审核任务。
开始审核
音视频审核服务配置为手动启动时,需要调用该接口启动审核任务。
请求方法
POST: http://api.rong-api.com/rtc/contentcensor/start.json
签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文中包含具有以下结构的 JSON 对象:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
users | Array | 是 | 需要开启审核任务的用户列表。 |
users[i].userId | String | 否 | 指定需要进行审核的用户 ID。 |
users[i].interceptFrequency | Number | 否 | 数美审核服务的截帧频率间隔,用于调节每次截取视频帧送审之间的时长。单位为秒,取值范围为 1~60s ;不传为客户在数美后台配置的默认截帧频率间隔(默认 3s)。该字段只针对数美审核有效,数美对应参数为 detectFrequency 。 |
users[i].scene | String | 否 | 指定该用户的审核场景,对应数美不同的审核策略;只针对使用数美审核(如与数美无约定,可不填),使用其他审核提供商不需要填写。 |
users[i].censorType | Number | 否 | 指定该用户需要送审的流类型;只针对使用数美审核。0 :只审核该用户的音频流;1 :只审核该用户的视频流;2 :审核该用户的音频流和视频流。如果不传或传入非法值,则以控制台 IM & 音视频审核页面音视频服务配置下数美审核对应的审核类型为准。 |
users[i].streams | Array | 否 | 用户对应的音视频流信息。 |
users[i].streams[i].streamId | String | 否 | 流 ID。 |
请求示例
POST /rtc/contentcensor/start.json HTTP/1.1
Host: api.rong-api.com
App-Key: XXX
Nonce: 1027489915
Timestamp: 1609754958
Signature: 357cef9b529edd1ed4f34bd8df52de00a909914b
Room-Id: 123
Session-Id: 456
Content-Type: application/json
{
"users": [{
"userId": "xxxxx",
"scene": "xxx",
"censorType": 0,
"streams": [{
"streamId": "xxxxx"
}]
},
{
"userId": "xxxx2x",
"scene": "xxx",
"censorType": 1,
"streams": [{
"streamId": "xxx3xx"
},
{
"streamId": "xx4xxx"
}
]
}
]
}
返回结果
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
resultCode | Number | 是 | 状态码。 |
reason | String | 是 | 接口调用状态说明。 |
返回结果示例
返回结果包含具有以下结构的 JSON 对象:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"reason": "the roomId or userId was not exist",
"resultCode": 49009
}
结束审核
会话结束时自动停止审核。如需手动结束审核任 务,可调用该接口
请求方法
POST: http://api.rong-api.com/rtc/contentcensor/stop.json
签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文中包含具有以下结构的 JSON 对象:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
users | Array | 是 | 指定所需结束的审核任务对应的用户列表。 |
users[i].userId | String | 否 | 用户 ID。 |
users[i].streams | Array | 否 | 用户对应的音视频流信息。 |
users[i].streams[i].streamId | String | 否 | 流 ID。 |
请求示例
POST /rtc/contentcensor/stop.json HTTP/1.1
Host: api.rong-api.com
App-Key: XXX
Nonce: 1027489915
Timestamp: 1609754958
Signature: 357cef9b529edd1ed4f34bd8df52de00a909914b
room-id: 123
session-id: 456
Content-Type: application/json
{
"users": [{
"userId": "xxxxx",
"streams": [{
"streamId": "xxxxx"
}]
},
{
"userId": "xxxx2x",
"streams": [{
"streamId": "xxx3xx"
},
{
"streamId": "xx4xxx"
}
]
}
]
}
返回结果示例
返回结果包含具有以下结构的 JSON 对象:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"reason": "the roomId or userId was not exist",
"resultCode": 49009
}