圖片上傳 API
透過此 API,您可將經過 Base64 編碼的圖片檔案上傳至 PaaSoo 伺服器,並取得一個唯一的圖片連結 (address)。 在後續發送多媒體簡訊(MMS)時,可將此連結用作 attachment 欄位的值,實現圖片多媒體簡訊的快速交付。
1. 呼叫方式
呼叫方式
- HTTP Method:
POST - Content-Type:
application/json - API Endpoint:
https://api.paasoo.com.tw/image/upload - 安全性:建議使用 HTTPS 協定,需攜帶正確的
key與secret。 - 圖片大小限制:建議 300KB 以內。超出限制需與 PaaSoo 協商或進行適當壓縮。
2. 請求範例
以下以 cURL 為例,展示如何透過 POST + application/json 的方式上傳圖片:
cURL
curl -X POST "https://api.paasoo.com.tw/image/upload" \
-H "Content-Type: application/json" \
--data-raw '{ "key": "API_KEY", "secret": "API_SECRET", "content": "xxxx", "format": "jpg" }'
說明
content 應為 Base64 編碼的圖片資料;請確認圖片大小在 300KB 以內。
format 僅支援 jpg 或 png。
3. 請求參數說明
| 參數 | 類型 | 必填 | 描述 | 範例 |
|---|---|---|---|---|
| key | string | 是 | API Key(字母或數字構成,共 8 位),用於唯一標識您的帳戶。可在 PaaSoo 用戶端後台取得。 | Abcdefgh |
| secret | string | 是 | API Secret(字母或數字構成,共 8 位),與 key 配合使用以進行身分驗證。可在 PaaSoo 用戶端後台取得。 | Abc123EF |
| content | string | 是 | Base64 編碼的圖片內容,大小建議 <300KB。 | iVBORw0KGgoA... |
| format | string | 是 | 圖片格式,僅支援 jpg 或 png。 | jpg |
4. 回應參數說明
4.1 回應欄位說明
| 參數 | 類型 | 描述 | 範例 |
|---|---|---|---|
| status | integer | 提交至 PaaSoo 雲通訊平台的回應狀態碼。 介面狀態碼列表:
| 0 |
| status_code | string | 狀態描述。 | Missing parameters |
| address | string | 圖片在 PaaSoo 伺服器上的唯一存取連結。 | https://files.example.com/images/mms/example.jpg |
| format | string | 圖片類型,例如 jpg 或 png。 | jpg |
| size | integer | 圖片大小 (單位:KB)。 | 233 |
4.2 成功回應範例
{
"status": 0,
"address": "https://files.example.com/images/mms/example.jpg",
"format": "jpg",
"size": 233
}
說明
status = 0 表示上傳成功。
address 為圖片的唯一存取連結,可在後續多媒體簡訊中使用。
format 與 size 分別表示圖片的檔案格式與大小(單位:KB)。
4.3 失敗回應範例
{
"status": 2,
"status_code": "Missing parameters."
}
說明
status = 2 表示請求參數缺失或錯誤。
5. 最佳實踐與注意事項
- 圖片格式與體積:為確保多媒體簡訊發送的穩定性與相容性,請使用 JPG 或 PNG 格式,且大小盡量控制在 300KB 以內。
- 圖片品質與顯示:多媒體簡訊在不同終端與營運商網路上可能存在因轉碼或壓縮導致的清晰度差異,請提前測試。
- 加密與安全:建議使用 HTTPS 協定進行上傳,以防止敏感資料(
key、secret)被截獲。 - 回呼與日誌:若需對上傳記錄和使用情況進行追蹤,建議在業務邏輯中保留上傳成功後返回的
address,並與目標多媒體簡訊記錄關聯。 - 自動清理:所有已上傳的圖片可能會在 30 天後自動從伺服器上刪除。如果您需要更長時間保留,請提前與 PaaSoo 協商。
6. 附錄
- 後續使用:取得的
address可直接填入多媒體簡訊發送介面的attachment參數,實現低延遲、高可用的圖片傳輸。 - 重用與過期:一旦上傳成功,圖片連結一般不會立即過期,但如上所述,伺服器或會在 30 天後自動刪除圖片。
- 海量圖片:如果您需要頻繁上傳大量圖片,請與我們聯絡,了解批次上傳或額外頻寬預算等方案。
技術支援
如在 API 對接過程中遇到任何技術問題或業務疑問,歡迎隨時聯絡我們的開發者支援團隊:support@paasoo.com。我們將竭誠為您提供技術協助。