logo
当前页

StopTranscode

POST

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

注意
  1. 本文档 API 接口均为最新服务端 API v2 接口,后续相关功能的新增都会在此更新。为了给开发者带来更好的体验,ZEGO 推荐开发者使用最新 API v2 接口。
  2. 文件转码旧版 API 仅供 2021-09-10 前接入的旧用户维护使用。旧版接口文档请参考 旧版服务端 API

描述

通过本接口取消未开始的文件转码任务,如果转码任务开始后调用此接口会返回错误。

说明
调用频率限制:10 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [StopTranscode]

    接口原型参数

    https://docs-api.zego.im/?Action=StopTranscode

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Signature string必填

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

Body

required
    TaskId string必填

    文件转码任务 ID。

Responses

OK
Schema
    Code int64

    错误码。

    以下仅列出了接口业务相关的返回码,公共返回码请参考 公共返回码

    返回码说明
    60013文件已经完成转码。
    60014不存在的文件转码任务 ID。
    Message string

    错误描述。

    RequestId string

    请求 ID。

上一篇

查询文件转码状态

下一篇

删除文件

当前页

返回到顶部