發起截圖任務
更新時間 2025-04-16 10:39:52
最近更新時間: 2025-04-16 10:39:52
分享文章
用戶可通過本接口發起一個截圖任務。
接口功能介紹
用戶可通過本接口發起一個截圖任務。
接口約束
本接口的單用戶QPS限制為20次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
URI
POST /xstore-vod/snapshot/task
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| originVideoUuid | 是 | String | 源視頻videoID。 | 494df3af1bd04fc28e2f0c5b73a45b6d | |
| templateId | 是 | String | 必填參數，截圖模板ID。 | 100000000001 | |
| watermarkTemplateId | 否 | String | 選填參數，水印模板ID，截圖打水印時傳入該入參。 | 100000000001 | |
| clientCallbackUrl | 否 | String | 選填參數，本次截圖任務的回調地址。注意，當填入本參數時，后臺會優先將回調信息發送至本次指定接收地址。工作流或全局回調地址均不再發送回調。 | //sample.daliqc.cn/Callback |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次請求的結果碼。 | 0 | |
| message | 是 | String | 錯誤文本信息，發起成功時，為空字符串。 | "" | |
| data | 是 | Object | 返回的結果。 | data |
表data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| taskId | 是 | String | 截圖任務taskId。 | 0003#xs-guangdong0002 |
請求示例
請求體body
{
"originVideoUuid": "494df3af1bd04fc28e2f0c5b73a45b6d",
"templateId": 100000000001,
"watermarkTemplateId": 100000000001，
"clientCallbackUrl": //sample.daliqc.cn/Callback
}
響應示例
{
"code":"0",
"message":"",
"data":{
"taskId":"0003#xs-guangdong0002"
}
}
狀態碼
| Http 狀態碼 | 狀態碼信息 | 狀態碼描述 |
|---|---|---|
| 0 | 表示業務成功 | 表示業務成功 |
| 400 | 請求參數有誤 | 請求參數有誤 |
| 403 | 用戶鑒權失敗，用戶無操作權限 | 用戶鑒權失敗，用戶無操作權限 |
| 404 | 請求的資源不存在，輸入錯誤的URL | 請求的資源不存在，輸入錯誤的URL |
| 500 | 業務執行異常 | 業務執行異常 |
錯誤碼
OpenAPI錯誤碼請參考 錯誤碼說明。
