グループSMS

APIドキュメント

グループSMS APIをアプリケーションに統合するための完全なリファレンス。

Base URL

https://api-2ue64mzmvq-du.a.run.app

🔐 Authentication

すべてのAPIリクエストにはAPIキーを使用した認証が必要です。APIキーをX-API-Keyヘッダーに含めてください。

認証ヘッダー

X-API-Key: gsms_live_your_api_key_here

APIキーを取得: グループSMSアプリをダウンロードし、アカウントを作成後、設定 > 開発者APIからAPIキーを生成してください。

APIキー形式

  • ●gsms_live_xxxxx本番環境（実際のSMS）
  • ●gsms_test_xxxxxテスト環境（サンドボックスモード）

📡 Endpoints

SMS操作用の利用可能なAPIエンドポイント。

POST/api/v1/developer/send

1人以上の受信者にSMSメッセージを送信

GET/api/v1/developer/status/:batchId

バッチの配信ステータスを確認

📤 Send SMS

1人以上の受信者にSMSメッセージを送信します。メッセージはキューに追加され、Androidフォンから送信されます。

POST/api/v1/developer/send

リクエストボディ

recipients
requiredarray

電話番号とメッセージを含む受信者の配列

phone
requiredstring

受信者の電話番号（E.164形式推奨：+821012345678）

message
requiredstring

メッセージテキスト（メッセージあたり最大2000文字）

レスポンス

{
  "success": true,
  "batchId": "batch_1736416234_a1b2c3",
  "totalCount": 2,
  "estimatedDeliveryTime": "2-5 minutes"
}

コード例

curl -X POST https://api-2ue64mzmvq-du.a.run.app/api/v1/developer/send \
  -H "X-API-Key: gsms_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"recipients":[{"phone":"+821012345678","message":"Your verification code is 123456"},{"phone":"+821087654321","message":"Hello! This is a test message."}]}'

📊 Get Status

送信エンドポイントから返されたbatchIdを使用して、メッセージバッチの配信ステータスを取得します。

GET/api/v1/developer/status/:batchId

レスポンス

{
  "success": true,
  "batchId": "batch_1736416234_a1b2c3",
  "status": "completed",
  "totalCount": 10,
  "sentCount": 8,
  "failedCount": 2,
  "createdAt": "2026-01-09T03:30:34.000Z",
  "completedAt": "2026-01-09T03:35:12.000Z"
}

ステータス値

  • pending - バッチ作成済み、処理待ち
  • processing - 現在メッセージ送信中
  • completed - すべてのメッセージが正常に送信済み
  • partial - 一部のメッセージが送信済み、一部が失敗
  • failed - すべてのメッセージの送信に失敗

コード例

curl -X GET https://api-2ue64mzmvq-du.a.run.app/api/v1/developer/status/batch_1234567890 \
  -H "X-API-Key: gsms_live_your_api_key_here"

⚠️ Error Codes

APIは標準HTTPステータスコードを使用して成功または失敗を示します。

401

未認証

無効または欠落しているAPIキー。X-API-Keyヘッダーを確認してください。

400

不正なリクエスト

無効なリクエスト形式。JSONペイロードと必須フィールドを確認してください。

429

リクエスト過多

レート制限を超過。さらにリクエストを行う前に待機してください。

500

内部サーバーエラー

サーバー側でエラーが発生しました。後でもう一度お試しください。

⏱️ Rate Limits

公正な使用を確保するため、APIはすべてのエンドポイントにレート制限を適用します。

100
1日あたりのメッセージ数（無料プラン）
10
1分あたりのリクエスト数

より高い制限が必要ですか？: より高い制限と専用サポートを含むエンタープライズプランについてお問い合わせください。

サポートが必要ですか？

クイックスタートガイドを確認するか、よくある質問を参照してください。

クイックスタートガイド