跳至主要内容

圖片刪除 API

透過此 API，您可刪除先前上傳到 PaaSoo 平台的圖片檔案。該操作適用於主動清理不再需要的圖片資源，從而減少冗餘占用。

1. 呼叫方式​

呼叫方式
  • HTTP Method：GET
  • API Endpoint：https://api.paasoo.com.tw/image/delete
  • 請求參數：透過 key、secret 和 address 拼接於 URL 中。

注意事項：address 參數必須進行 URL 編碼，以避免傳遞特殊字元時出錯。

2. 請求範例​

以下為直接在瀏覽器或命令列中 GET 請求的範例：

https://api.paasoo.com.tw/image/delete?key=API_KEY&secret=API_SECRET&address=ENCODED_IMAGE_URL
說明
  • ENCODED_IMAGE_URL 指將原始圖片連結使用 UTF-8 格式進行 URL 編碼後的結果。
  • 若需測試編碼效果，可使用線上工具進行文字轉換。

3. 請求參數說明​

參數類型必填描述範例
keystring是API Key（字母或數字構成，共 8 位），用於唯一標識您的帳戶。可在 PaaSoo 用戶端後台取得。Abcdefgh
secretstring是API Secret（字母或數字構成，共 8 位），與 key 配合使用以進行身分驗證。可在 PaaSoo 用戶端後台取得。Abc123EF
addressstring是待刪除圖片的位址，請進行 URL 編碼後再附加到請求參數。https%3A%2F%2Ffiles.example.com%2Fimages%2Fxxx.jpg

4. 回應參數說明​

4.1 回應欄位說明​

參數類型描述範例
statusinteger提交至 PaaSoo 雲通訊平台的回應狀態碼。
介面狀態碼列表：
  • 0 - success：刪除成功
  • 2 - Missing parameters：缺少必要參數
  • 3 - Invalid parameters：參數格式錯誤
  • 4 - Invalid credentials：key 或 secret 錯誤
  • 5 - Unauthorized IP：IP 限制
  • 11 - System error：系統錯誤
0
status_codestring狀態描述。Missing parameters

4.2 成功回應範例​

{
    "status": 0,
    "status_code": "success"
}

說明：status = 0 表示圖片檔案已成功刪除。

4.3 失敗回應範例​

{
    "status": 2,
    "status_code": "Missing parameters."
}

說明：status = 2 表示請求中缺少必要參數。

5. 最佳實踐與注意事項​

  1. 刪除不可恢復：一旦執行此刪除操作，被刪除的圖片將無法恢復，請謹慎呼叫。
  2. 安全性：建議結合 HTTPS 協定與 IP白名單進行保護，避免非授權請求惡意刪除資源。
  3. 參數校驗：在提交刪除請求前，請確保已正確進行 URL 編碼，並且 key、secret 無誤。
  4. 配合使用：建議將本 API 與圖片上傳 API、多媒體簡訊發送 API 結合使用，及時清理過期或不再需要的圖片。
  5. 自動清理：為提升系統效率，PaaSoo 可能會在圖片上傳 30 天後自動刪除該圖片。如果您在 30 天後呼叫本介面，圖片可能已被系統清理而無法再次刪除。

6. 附錄​

  • 日誌記錄：對刪除操作進行日誌記錄，可在後續進行審計或問題排查時作為參考。
  • 自動化策略：如有定期清理需求，可在業務端開發自動任務，呼叫該介面進行批次刪除。
技術支援

如在 API 對接過程中遇到任何技術問題或業務疑問，歡迎隨時聯絡我們的開發者支援團隊：support@paasoo.com。我們將竭誠為您提供技術協助。