You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

任务状态查询 ListDetectionTask

最近更新时间：2024.04.02 19:32:44

首次发布时间：2022.03.16 15:12:04

我的收藏

你可以使用 ListDetectionTask 接口，查询指定用户的审核状态。

使用说明

接口行为

你可以使用 ListDetectionTask 接口，查询房间内指定用户通过 RTC 发送的音视频内容是否正处于审核中。

请求说明

  • 请求方式：GET
  • 请求地址：https://rtc.volcengineapi.com?Action=ListDetectionTask&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
是
ListDetectionTask
接口名称。当前 API 的名称为 ListDetectionTask。
Version
String
是
2020-12-01
接口版本。当前 API 的版本为 2020-12-01。
AppId
String
是
Your_AppId
应用的唯一标志
RoomId
String
是
Your_RoomId
房间 ID，是房间的唯一标志
UserId
String
否
Your_UserId
用户 ID

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数
类型
示例值
描述
EventData
Object[]
-
任务状态信息。如果从未对指定的用户发起审核，查询其审核状态时，返回的 EventData 值为空列表。
CreateTime
Integer
1629183877
用户审核发起时间戳，unix 时间，单位为秒。
MediaType
Integer
1
进行审核的内容类型：
1：视频截图；
2：音频切片；
3：视频截图+音频切片（默认值）
Status
Integer
1
审核状态：
1：运行中：
2：已完成；
UserId
String
Your_UserId
若开始审核接口填入 UserId，此处返回填入 UserId。若开始审核接口未填入 UserId，此处返回房间内触发过审核任务的用户的 UserId。每一个 EventData 返回一个 UserId。
RoomId
String
Your_RoomId
审核房间 ID
Message
String
success
仅在请求成功时返回success。

请求示例

GET https://rtc.volcengineapi.com?Action=ListDetectionTask&Version=2020-12-01&AppId=Your_AppId&RoomId=Your_RoomId&UserId=Your_UserId

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "ListDetectionTask",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "EventData": [
            {
                "CreateTime": 1629183877,
                "MediaType": 1,
                "Status": 1,
                "UserId": "Your_UserId",
                "RoomId": "Your_RoomId"
            }
        ],
        "Message": "success"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。