文档中心
hybrid_hierarchical_delivery_system 超低延迟直播
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 超低延迟直播
  • 服务端 API
  • 混流转码接口
  • 停止单流转码

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

停止单流转码

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

1 简介

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

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

2 接口原型

  • 请求方法:POST

    使用 POST 请求方法传递参数时:

    • Body 中的参数直接传 JsonObject 格式即可,无需序列化为 String 格式。
    • Headers 中,设置 “Content-type” 为 “application/json”。
  • 请求地址:https://rtc-api.zego.im/?Action=StopCloudTranscode
  • 传输协议:HTTPS
  • 调用频率限制:100 次/秒

3 请求参数

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

此接口中只有部分参数在开始混流后支持动态更新,未标注的则不支持动态更新,详情请参考下表中的参数描述。

名称 类型 必填 描述
TaskId
String
是
任务 ID,单流转码任务的唯一标识,由开发者自定义。
UserId
String
是
用户 ID。当开启单流转码任务归属时,停止某个 TaskId 的转码任务必须输入 开始单流转码 任务时指定的 UserId。
Sequence
Int
否
转码任务的序列号,用于保证时序,同个任务的参数修改需要保证序列号的递增。

4 请求示例

  • 请求 URL

    https://rtc-api.zego.im/?Action=StopCloudTranscode
    &<公共请求参数>    
  • 请求消息体

    {
        "TaskId": "2213699902971205739",
        "UserId": "456"
    }

5 响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "8472822294336370476"
}

7 返回码

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

返回码 说明 处理建议
110200002 输入参数错误。 请参考 Message 信息处理。
110200151 单流转码任务失败。 请重试,或联系 ZEGO 技术支持处理。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈