提交轉碼任務
更新時間 2025-04-16 10:39:51
最近更新時間: 2025-04-16 10:39:51
分享文章
通過本接口向云點播提交一個轉碼任務。
接口功能介紹
用戶可通過本接口向云點播提交一個轉碼任務。
接口約束
本接口的單用戶QPS限制為20次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
URI
POST /task/submit
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| videoId | 是 | String | 視頻id | 34c71dba-f280-4f5e-a05f-f4daed837fef | |
| useDefaultTranscodeTemplate | 否 | Boolean | 可選參數，是否使用默認的轉碼模板。如果不傳入默認為 false。 | true | |
| transcodeTemplates | 否 | Array of Longs | 當 useDefaultTranscodeTemplate為 true 時，該字段無效。當 useDefaultTranscodeTemplate 為 fasle 或者不傳入時，該字段必填。 |
[100000000003,100000000004] | |
| watermarkTemplate | 否 | Long | 可選參數，水印模板id：若傳入表示加水印；不傳入則不加水印。 | 100000000003 | |
| callback | 否 | String | 可選參數，任務結束之后將回調到該地址告知任務狀態。 注意：（1）當填入本參數時，后臺會優先將回調信息發送至本次指定接收地址。工作流或全局回調地址均不再發送回調。 （2）由于歷史原因，通過本參數獲得的回調信息格式與通用回調格式存在差異。請參考音視頻轉碼完成-點播模式（接口回調） 描述。 |
//callback.daliqc.cn/callback |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次請求的結果碼。 | 0 | |
| message | 是 | String | 錯誤文本信息，執行成功時，為空字符串。 | -- | |
| data | 是 | Object | 返回數據。 | data |
表 data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| transcodeTaskIds | 是 | Array of Strings | 轉碼任務的 id，可以通過這些轉碼任務 id 查詢相關的任務。 | ["0001#1a619cdd3f19406794f9663ee246cb7e", "0001#1a619cdd3f19406794f9663ee246cbr8"] |
請求示例
請求體body
{
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fef",
"useDefaultTranscodeTemplate": true,
"transcodeTemplates": [100000000003, 100000000004],
"watermarkTemplate": 100000000003,
"callback": "//callback.daliqc.cn/callback"
}
響應示例
{
"code": 0,
"message": "",
"data": {
"transcodeTaskIds": ["0001#1a619cdd3f19406794f9663ee246cb7e", "0001#1a619cdd3f19406794f9663ee246cbr8"]
}
}
狀態碼
| Http 狀態碼 | 狀態碼信息 | 狀態碼描述 |
|---|---|---|
| 0 | 表示業務成功 | 表示業務成功 |
| 400 | 請求參數有誤 | 請求參數有誤 |
| 403 | 用戶鑒權失敗，用戶無操作權限 | 用戶鑒權失敗，用戶無操作權限 |
| 404 | 請求的資源不存在，輸入錯誤的URL | 請求的資源不存在，輸入錯誤的URL |
| 500 | 業務執行異常 | 業務執行異常 |
錯誤碼
OpenAPI錯誤碼請參考 錯誤碼說明。
