Documentation
Super Board (Full version)
Server API V2
Cancel file transcoding

Cancel file transcoding

Last updated：2022-12-21 17:44

Description

Cancels a file transcoding task that has not been started. If this API is called after the task starts, an error is returned.

Request method and endpoint

Request method: POST
Request endpoint: https://docs-api.zego.im/?Action=StopTranscode
Protocol: HTTPS
Rate limit: 10 requests/second

Request parameters

Listed below are the parameters specific to this request. For the complete list of public request parameters, see Accessing Server APIs - Public parameters.

Parameter	Type	Required	Description
TaskId	String	Yes	File transcoding task ID.

Sample request

Request URL

https://docs-api.zego.im/?Action=StopTranscode
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
&IsTest=false

Request message body
```
{
  "TaskId": "task"
}
```

Response parameters

Parameter	Type	Description
Code	Int64	Error code.
Message	String	Error description.
RequestId	String	Request ID.

Sample response

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}

Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Return code	Description
60013	The file has been transcoded.
60014	The file transcoding task ID does not exist.