logo
实时音视频
服务端 API
场景服务接口
当前页

StopCloudTranscode

POST

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

调用本接口,停止单流转码任务。

“客户端”基于转码模板触发的单流转码介绍,请参考 单流转码; “服务端”的相关回调,请参考 单流转码开始回调单流转码停止回调

调用频率限制
100 次/秒

Request

Query Parameters

    Action string必填

    可选值: [StopCloudTranscode]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    Signature string必填

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

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

Body

required
    TaskId string必填

    任务 ID,单流转码任务的唯一标识,由开发者自定义。

    UserId string必填

    用户 ID。当开启单流转码任务归属时,停止某个 TaskId 的转码任务必须输入 开始单流转码 任务时指定的 UserId。

    Sequence int

    转码任务的序列号,用于保证时序,同个任务的参数修改需要保证序列号的递增。

Responses

操作成功
Schema
    Code int

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

    返回码说明处理建议
    110200002输入参数错误。请参考 Message 信息处理。
    110200151单流转码任务失败。请重试,或联系 ZEGO 技术支持处理。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。


Request
折叠所有
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
Body必填
{
"TaskId": "2213699902971205739",
"UserId": "456",
"Sequence": 0
}
RESPONSE清除

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

Previous

开始单流转码

Next

禁止 CDN 推流

当前页

返回到顶部