DescribeMediaTask

GET

https://rtc-api.zego.im/

本接口用于查询合并媒体文件、开始点播转码及开始点播截图任务的详细信息，作为媒体文件合并完成回调和点播转码完成回调的补充。

本接口支持查询“合并任务”、“转码任务”及“截图任务”的进度；任务完成后，也可以通过本接口获取合并文件或转码文件的播放地址。

调用频率限制

同一个 AppID 下所有房间：20 次/秒

Request

Query Parameters

Action stringrequired

Possible values: [DescribeMediaTask]

接口原型参数

https://rtc-api.zego.im?Action=DescribeMediaTask

AppId uint32required

💡公共参数。AppId，ZEGO 分配的用户唯一凭证。

SignatureNonce stringrequired

💡公共参数。随机字符串。

Timestamp int64required

💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

Signature stringrequired

💡公共参数。签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡公共参数。签名版本号。

IsTest string

Possible values: [true, false]

Default value: false

💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

TaskId stringrequired

需要查询的任务 ID，即合并媒体文件、开始点播转码及开始点播截图接口响应参数中 Data 内携带的 TaskId。

Vendor stringrequired

Possible values: [Tencent, Huawei]

可能的取值及对应的 CDN 厂商：

Tencent：腾讯云。
Huawei：华为云。

Responses

成功

application/json

Schema
Example (from schema)

Schema

Code int32

以下仅列出了接口业务逻辑相关的部分返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
0	请求成功。	-
2	输入参数错误。	-
3	未开通相关权限。	请联系 ZEGO 技术支持。
4	CDN 类型不匹配。	请检查参数。
5	配置错误。	请联系 ZEGO 技术支持。
6	请求过于频繁。	请稍后重试。
7	鉴权失败。	请检查鉴权参数是否正确。
1000	请求失败。	请联系 ZEGO 技术支持。

Message string

操作结果描述

RequestId string

请求 ID，由 ZEGO 服务端返回

Data object

响应数据

Tencent object

腾讯云返回内容（Vendor 取值为 Tencent 时返回）

TaskId string

查询的任务 ID

Event string

任务的事件类型，返回值为：

compose：媒体文件合并
transcode：媒体文件点播转码
SnapshotByTimeOffset：时间点截图任务
SampleSnapshot：时间间隔截图任务

Status string

任务状态：

WAITING：等待中
PROCESSING：处理中
FINISH：已完成
FAIL：失败

FileId string

媒体文件合并或转码后的文件 ID，与检索媒体信息接口响应参数中 Data 内携带的 FileId 相同

ReplayUrl string

媒体文件合并或转码后的文件回放地址，不超过 1024 字节

RequestId string

唯一请求 ID，由请求参数 Vendor 取值对应的 CDN 厂商（即腾讯云）返回，定位问题时需要提供该次请求的 RequestId

Message string

媒体文件任务失败的错误信息

ThumbnailsUrl string[]

点播截图任务生成的文件链接

Huawei object

华为云返回内容（Vendor 取值为 Huawei 时返回）

TaskId string

查询的任务 ID

Status string

任务状态：

NO_TASK：任务不存在
WAITING：等待处理
PROCESSING：处理中
SUCCEEDED：已完成
FAILED：失败
CANCELED：任务取消

CreateTime string

任务开始时间，云厂商服务端 UTC 时间

EndTime string

任务结束时间，云厂商服务端 UTC 时间

FileName string[]

点播截图任务生成的文件

{
  "Code": 0,
  "Message": "success",
  "RequestId": "",
  "Data": {
    "Tencent": {
      "TaskId": "1400341231-ComposeMedia-6fdfc967d7eb12f5e9b27f52519f1afatt0",
      "Event": "compose",
      "Status": "FINISH",
      "FileId": "xxxxxxxx",
      "ReplayUrl": "https://xxxxx-xxxxxxxx.zego.im/xxxxxxxx/xxxxxxx/xxxxxx.mp4",
      "RequestId": "6aac31f4-xxxx-xxxx-xxxx-5cc10ce11a49",
      "Message": "",
      "ThumbnailsUrl": [
        "http://vod-tc-restorefile.zego.im/43b7b075vodtranscq1500030200/93172bfa1397757897438985100/sampleSnapshot/sampleSnapshot_10_0.jpg",
        "http://vod-tc-restorefile.zego.im/43b7b075vodtranscq1500030200/93172bfa1397757897438985100/sampleSnapshot/sampleSnapshot_10_2.jpg"
      ]
    },
    "Huawei": {
      "TaskId": "289665200",
      "Status": "SUCCEEDED",
      "CreateTime": "20241118065429",
      "EndTime": "20241118065430",
      "FileName": [
        "record/pickrecord/command_record/clarechen_test/0.jpg",
        "record/pickrecord/command_record/clarechen_test/10.jpg"
      ]
    }
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "",
  "Data": {
    "Tencent": {
      "TaskId": "1400341231-ComposeMedia-6fdfc967d7eb12f5e9b27f52519f1afatt0",
      "Event": "compose",
      "Status": "FINISH",
      "FileId": "xxxxxxxx",
      "ReplayUrl": "https://xxxxx-xxxxxxxx.zego.im/xxxxxxxx/xxxxxxx/xxxxxx.mp4",
      "RequestId": "6aac31f4-xxxx-xxxx-xxxx-5cc10ce11a49",
      "Message": "",
      "ThumbnailsUrl": [
        "http://vod-tc-restorefile.zego.im/43b7b075vodtranscq1500030200/93172bfa1397757897438985100/sampleSnapshot/sampleSnapshot_10_0.jpg",
        "http://vod-tc-restorefile.zego.im/43b7b075vodtranscq1500030200/93172bfa1397757897438985100/sampleSnapshot/sampleSnapshot_10_2.jpg"
      ]
    },
    "Huawei": {
      "TaskId": "289665200",
      "Status": "SUCCEEDED",
      "CreateTime": "20241118065429",
      "EndTime": "20241118065430",
      "FileName": [
        "record/pickrecord/command_record/clarechen_test/0.jpg",
        "record/pickrecord/command_record/clarechen_test/10.jpg"
      ]
    }
  }
}

CURL

RESPONSEClear

Click the "Send" button above and see the response here!

DescribeMediaTask

https://rtc-api.zego.im/

Request

Query Parameters

Responses​

Responses