本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。
在实时音视频通话场景中,通过调用此接口,你能够查询房间内特定用户发送的音视频内容的审核状态。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListDetectionTask | 接口名称。当前 API 的名称为 ListDetectionTask 。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01 。 |
AppId | String | 是 | 661e****543cf | 应用的唯一标志 |
RoomId | String | 是 | Room1 | 房间 ID,是房间的唯一标志 |
UserId | String | 否 | user1 | 用户 ID |
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
EventData | Object[] | - | 任务状态信息。如果从未对指定的用户发起审核,查询其审核状态时,返回的 EventData 值为空列表。 |
CreateTime | Integer | 1629183877 | 用户审核发起时间戳,unix 时间,单位为秒。 |
MediaType | Integer | 1 | 进行审核的内容类型,支持取值及含义如下: 1 :视频截图;2 :音频切片;3 :视频截图+音频切片(默认值) |
Status | Integer | 1 | 审核状态,支持取值及含义如下: 1 :运行中:2 :已完成; |
UserId | String | user1 | 若开始审核接口填入 UserId ,此处返回填入 UserId 。若开始审核接口未填入 UserId ,此处返回房间内触发过审核任务的用户的 UserId 。每一个 EventData 返回一个 UserId 。 |
RoomId | String | room1 | 审核房间 ID |
Message | String | success | 仅在请求成功时返回success。 |
GET https://rtc.volcengineapi.com?Action=ListDetectionTask&Version=2023-11-01&AppId=661e****543cf&RoomId=Room1&UserId=user1
{ "ResponseMetadata": { "RequestId": "20230****10420", "Action": "ListDetectionTask", "Version": "2023-11-01", "Service": "rtc", "Region": "cn-north-1" }, "Result": { "EventData": [ { "CreateTime": 1629183877, "MediaType": 1, "Status": 1, "UserId": "user1", "RoomId": "Room1" } ], "Message": "success" } }
您可访问公共错误码,获取更多错误码信息。