logo
超低延迟直播
服务端 API
场景服务接口
当前页

DeleteMedia

GET

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

用户进行 CDN 录制时,会把录制好的媒体文件存放在 CDN 服务器上,用户可以调用本接口删除该文件。

注意
首次使用本接口之前,请确认是否已经开通 CDN 录制服务。若未开通,请前往 ZEGO 控制台 自助开通,详情请参考 控制台 - 服务配置 - CDN,或联系 ZEGO 技术支持开通。

调用频率限制
同一个 AppID 下所有房间:20 次/秒

Request

Query Parameters

    Action string必填

    可选值: [DeleteMedia]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Vendor string必填

    可选值: [Tencent, Ws, Huawei]

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

    Tencent:腾讯云。 Ws:网宿。 Huawei:华为云。
    FileId string[]必填

    可选值: >= 1, <= 100

    文件唯一标识,在 录制文件生成回调 中返回,最大支持 100 个媒体文件 FileId。

    请注意,各 CDN 厂商的录制文件唯一标识不同:

    • 腾讯云:FileID。
    • 网宿:PersistentId。
    • 华为云:ObsObject。

    您也可以通过 检索媒体信息 接口,获取媒体文件的唯一标识,标识对应的参数名称有所差异,请注意区分使用。

    示例:&FileId[]=5285890813221514958&FileId[]=5285890813221513290

Responses

成功
Schema
    Code int32

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

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

    操作结果描述。

    RequestId string

    请求 ID,由 ZEGO 服务端返回。

    Data object
    响应数据,由以下参数 JSON 序列化后生成。
    Deleted string[]

    成功删除的文件列表。

    Errors object[]
    未成功删除的文件列表。
  • Array[
  • Code string

    删除文件失败的错误码。

    Message string

    删除文件失败的错误消息。

    Key string

    删除失败的文件的唯一标识。

    RequestId string

    唯一请求 ID,由请求参数 Vendor 取值对应的 CDN 厂商返回,定位问题时需要提供该次请求的 RequestId。

  • ]

Request
折叠所有
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

检索媒体信息

Next

合并媒体文件

当前页

返回到顶部