アカウント残高照会 API

PaaSoo アカウントの残高状況をリアルタイムで把握しやすくするため、PaaSoo はアカウント残高を直接照会できるインターフェースを提供しています。このインターフェースを通じて、いつでもご自身のアカウントの利用可能残高を照会し、SMS ビジネスの資金管理、チャージ、または財務決済のニーズにタイムリーに対応することができます。

1. 呼び出しについて

呼び出し方法

HTTP Method：GET
リクエスト先：https://api.paasoo.com/balance
使用シナリオ：SMS 送信の前、最中、または後の任意の段階で、現在のアカウントまたはサブアカウント（階層がある場合）の残高を取得し、送信を継続するための要件を満たしているか評価する必要がある場合に、このインターフェースを呼び出すことができます。

2. リクエスト例

GET https://api.paasoo.com/balance?key=API_KEY&secret=API_SECRET

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

パラメータ	タイプ	必須	説明	例
key	string	はい	API Key（英数字8桁）。アカウントの一意の識別子として使用します。PaaSoo のクライアントバックグラウンドで取得できます。	Abcdefgh
secret	string	はい	API Secret（英数字8桁）。`key` と組み合わせて認証に使用します。PaaSoo のクライアントバックグラウンドで取得できます。	Abc123EF

4. レスポンス例

照会が成功すると、アカウントの現在の残高と通貨単位を受信します。照会に失敗した場合は、エラーコードと対応するメッセージが返されます。

4.1 レスポンスパラメータの説明

パラメータ	タイプ	説明	例
code	integer	レスポンスステータス。PaaSoo クラウド通信プラットフォームに送信されたレスポンスステータスコード。一般的に、0 は成功を表します。	0
descr	string	`code` に対応するステータスの説明情報。エラーの原因や詳細なステータスを説明するために使用されます。	Missing parameters
balance	string	現在のアカウント残高。この値には小数部分が含まれる場合があり、具体的な精度はアカウントタイプや通貨単位に依存します。	1234.56
creditLimit	string	現在のアカウントのクレジット限度額。この値には小数部分が含まれる場合があり、具体的な精度はアカウントタイプや通貨単位に依存します。	0
currency	string	アカウント残高に対応する通貨単位または記号（USD、SGD、CNY など）。	USD

4.2 成功レスポンス例

{
    "balance": "9999.99999",
    "creditLimit": "-1000",
    "currency": "EUR"
}

4.3 失敗レスポンス例

{
    "code": 4,
    "descr": "Invalid credentials"
}

5. インターフェースステータスコード一覧

0 - success: 成功
2 - Missing parameters: 必須パラメータの欠落
3 - Invalid parameters: パラメータの形式エラー
4 - Invalid credentials: Key または Secret の誤り
5 - Unauthorized IP: IP制限
11 - System error: システムエラー

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

呼び出し頻度：
- サーバーへの過度な負荷を避けるため、業務量に応じて合理的な照会頻度を設計してください。頻繁すぎる照会はレート制限を引き起こす可能性があります。
セキュリティ：
- HTTPS チャネルでこのインターフェースを呼び出し、key や secret などの機密情報が盗まれないようにしてください。
- IPホワイトリストによるアクセス制限を検討し、セキュリティレベルをさらに向上させることができます。
利用枠の監視：
- 大規模な SMS 送信や定期的な送信の前に、内部システムにこのインターフェースを統合して残高チェックを行い、不足している場合はリマインダーや自動チャージを行うことができます。
同時照会：
- サブアカウントや複数の業務モジュールで同じアカウントを共有している場合は、照会頻度の制御と残高使用の予測を確実に行い、超過や競合による送信失敗を防いでください。

7. まとめ

このアカウント残高リアルタイム照会 API を通じて、手動で管理バックグラウンドにログインしたり、毎日または定期的な照合通知を待つことなく、現在の利用可能残高と通貨タイプをいつでも取得できます。 PaaSoo の他の SMS API、バッチステータス API、および配信コールバックと組み合わせることで、SMS のプロセス全体で自動化された詳細な監視と管理を実現できます。

テクニカルサポート

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

1. 呼び出しについて​

2. リクエスト例​

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

4. レスポンス例​

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

4.2 成功レスポンス例​

4.3 失敗レスポンス例​

5. インターフェースステータスコード一覧​

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

7. まとめ​