StopCloudTranscode

POST

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

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

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

调用频率限制

100 次/秒

Request

Query Parameters

Action stringrequired

Possible values: [StopCloudTranscode]

接口原型参数

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

AppId uint32required

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

SignatureNonce stringrequired

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

Timestamp int64required

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

Signature stringrequired

💡公共参数。签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

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

IsTest string

Possible values: [true, false]

Default value: false

💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

application/json

Body

required

TaskId stringrequired

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

UserId stringrequired

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

Sequence int

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

Responses

操作成功

application/json

Schema
Example (from schema)

Schema

Code int

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

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

Message string

操作结果描述。

RequestId string

请求 ID。

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

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

CURL

RESPONSEClear

Click the "Send" button above and see the response here!