文档中心
ExpressAudioSDK 实时语音
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 实时语音
  • 服务端 API
  • 媒体文件接口
  • 查询媒体文件任务

服务端 API 版块于4月16日至5月15日升级维护,期间暂停信息更新,如有任何疑问,请联系ZEGO技术支持。

查询媒体文件任务

更新时间:2025-04-15 17:17

1 描述

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

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

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=DescribeMediaTask
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 中的 “2.1 公共请求参数”。

参数 类型 是否必选 描述
TaskId
String
是
需要查询的任务 ID,即 合并媒体文件、开始点播转码 及 开始点播截图 接口响应参数中 Data 内携带的 TaskId。
Vendor
String
是
可能的取值及对应的 CDN 厂商:

  • Tencent:腾讯云。
  • Huawei:华为云。
  • 注意:当前华为云只支持查询截图任务,暂不支持查询合并任务和转码任务。

4 请求示例

https://rtc-api.zego.im/?Action=DescribeMediaTask
&Vendor=Tencent
&TaskId=1234567890
&<公共请求参数>

5 响应参数

参数 类型 描述
Code
Number
返回码。
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
Array of String
点播截图任务生成的文件链接。
Huawei
Object
华为云返回内容(Vendor 取值为 Huawei 时返回)。
TaskId
String
查询的任务 ID。
Status
String
任务状态。
  • NO_TASK:任务不存在。
  • WAITING:等待处理。
  • PROCESSING:处理中。
  • SUCCEEDED:已完成。
  • FAILED:失败。
  • CANCELED:任务取消。
CreateTime
String
任务开始时间,云厂商服务端 UTC 时间。
EndTime
String
任务结束时间,云厂商服务端 UTC 时间。
FileName
Array of String
点播截图任务生成的文件。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "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",]}
    "RequestId": ""
}

7 返回码

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

返回码 说明 处理建议
0 请求成功。 -
2 输入参数错误。 -
3 未开通相关权限。 请联系 ZEGO 技术支持。
4 CDN 类型不匹配。 请检查参数。
5 配置错误。 请联系 ZEGO 技术支持。
6 请求过于频繁。 请稍后重试。
7 鉴权失败。 请检查鉴权参数是否正确。
1000 请求失败。 请联系 ZEGO 技术支持。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈