画像アップロード API

この API を使用すると、Base64 エンコードされた画像ファイルを PaaSoo サーバーにアップロードし、一意の画像リンク (address) を取得できます。後続の MMS 送信時に、このリンクを attachment フィールドの値として使用することで、画像 MMS の迅速な配信を実現できます。

1. 呼び出し方法

呼び出し方法

HTTP Method：POST
Content-Type：application/json
API エンドポイント：https://api.paasoo.com/image/upload
セキュリティ：HTTPS プロトコルの使用を推奨します。また、正しい key と secret を付与する必要があります。
画像サイズ制限：300KB 以内を推奨します。制限を超える場合は、PaaSoo にご相談いただくか、適切に圧縮を行ってください。

2. リクエストのサンプル

以下は cURL を例とし、POST + application/json 方式で画像をアップロードする方法を示しています：

cURL
curl -X POST "https://api.paasoo.com/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 クラウド通信プラットフォームに送信された際のレスポンスステータスコード。 API ステータスコード一覧： 0 - success：送信成功 2 - Missing parameters：必須パラメータの欠落 3 - Invalid parameters：パラメータ形式のエラー 4 - Invalid credentials：`key` または `secret` のエラー 5 - Unauthorized IP：IP 制限 11 - System error：システムエラー 13 - Invalid attachment file：画像ファイルが不正 16 - Attachment size more than 300KB：画像サイズが制限超過	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 は画像の一意のアクセスリンクであり、後続の MMS で使用できます。
format と size はそれぞれ画像のファイルフォーマットとサイズ（単位：KB）を示します。

4.3 失敗レスポンスのサンプル

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

説明

status = 2 はリクエストパラメータの欠落またはエラーを示します。

5. ベストプラクティスと注意事項

画像フォーマットとファイルサイズ：MMS 送信の安定性と互換性を確保するため、JPG または PNG フォーマットを使用し、サイズは極力 300KB 以内に抑えてください。
画像の品質と表示：MMS は、端末やキャリアネットワークによってトランスコーディングや圧縮が行われ、解像度に差が生じる可能性があります。事前にテストを行ってください。
暗号化とセキュリティ：機密データ（key、secret）の傍受を防ぐため、アップロードには HTTPS プロトコルを使用することをお勧めします。
コールバックとログ：アップロード履歴と使用状況を追跡する必要がある場合は、ビジネスロジック内でアップロード成功後に返される address を保存し、ターゲットの MMS レコードと関連付けることをお勧めします。
自動クリーンアップ：アップロードされたすべての画像は、30 日後にサーバーから自動的に削除される場合があります。より長期間保存する必要がある場合は、事前に PaaSoo にご相談ください。

6. 付録

後続の使用：取得した address は、MMS 送信 API の attachment パラメータに直接入力することで、低遅延かつ高可用な画像転送を実現できます。
再利用と期限切れ：一度アップロードが成功すると、画像リンクは通常すぐには期限切れになりませんが、前述の通り、サーバーは 30 日後に画像を自動的に削除する場合があります。
大量の画像：大量の画像を頻繁にアップロードする必要がある場合は、一括アップロードや追加の帯域幅予算などのソリューションについてお問い合わせください。

テクニカルサポート

API 連携の過程で技術的な問題やビジネスに関する疑問が生じた場合は、いつでも当社の開発者サポートチーム（support@paasoo.com）までご連絡ください。誠心誠意、技術的なサポートを提供いたします。

1. 呼び出し方法​

2. リクエストのサンプル​

3. リクエストパラメータの説明​

4. レスポンスパラメータの説明​

4.1 レスポンスフィールドの説明​

4.2 成功レスポンスのサンプル​

4.3 失敗レスポンスのサンプル​

5. ベストプラクティスと注意事項​

6. 付録​