REST API ドキュメント
SMS・MMS REST API
承認済みのアプリケーションメッセージを送信し、受付、配信イベント、セグメント分割、課金を処理できます。
API と認証情報を合わせて選択する
承認済みの「開発者・自動化」「ビジネス」「通信事業者」のアカウントは、有効化されたサービスを連携できます。個人の開発者が企業を装う必要はありません。アプリケーションからの SMS/MMS には、該当する送信承認と登録が必要です。「パーソナル＆ファミリー」サービスには、お客様が利用できるメッセージ発信用 API はありません。
| API ファミリー | ベース URL | 認証と結果 |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | 承認済みの Basic 認証情報。プロビジョニングされた対象のトークンは、それをサポートする操作でのみ使用できます。JSON の status と response。 |
| 緊急通報の登録 | https://api.multi.tel/emergency | 承認済みの Basic 認証情報、または個別にプロビジョニングされたベアラーアクセス。JSON の code、message、data。 |
| ポータルの REST 連携 | お客様のアカウントの開発者向けリファレンスに表示されるホストと操作 | その操作について文書化されている認証情報、スコープ、スキーマを使用してください。ブラウザーのセッションによるリクエストは、別のインターフェースを使用します。 |
例を使用する前に、サーバーのシークレット設定で MULTITEL_API_USERNAME と MULTITEL_API_PASSWORD を設定してください。これらを公開ブラウザーの JavaScript、URL、ソース管理に埋め込まないでください。専用の認証情報は API 連携設定で管理します。
SMS リクエストを準備する
アカウントが所有する、承認済みで SMS が有効な送信番号と、メッセージの受信に同意した受信者を使用し、必要な Brand/Campaign 登録または着信者課金番号の確認を済ませてください。以下の例は、動作する認証情報と番号を設定すると実際にメッセージを送信します。サンドボックスではありません。
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"送信者と受信者のプレースホルダーを、国番号を含む国際形式の電話番号に置き換え、数字のみで指定してください。MMS の場合は、サポートされている、公開で取得可能なメディア URL を media に指定し、事前に MMS の利用資格と料金を確認してください。
受理は配信ではありません
外側のアプリケーションステータスと、返されたメッセージング結果の両方を確認してください。サービスが返すメッセージ識別子を記録し、配信ステータスと Webhook イベントを追跡してください。送信が成功したことは、受信者の端末がメッセージを受信したことの証明にはなりません。
SMS の課金はセグメントごとです。エンコーディングとメッセージの長さによって、複数のセグメントになる場合があります。メディアやキャリア関連の料金は、SMS とは異なる場合があります。送信前に、アカウントの現在の販売価格を確認してください。タイムアウトした送信を、確認せずに再試行しないでください。まず、記録されている結果を確認してください。
エラーと再試行の扱い
- 認証または権限の失敗
- API 認証情報の有効状態、許可されているサービス、送信元 IP の制限を確認してください。ポータルのセッション Cookie は連携用の認証情報ではありません。
- クレジット不足または承認の未完了
- 操作を繰り返す前に、アカウント残高、送信の承認、または書類要件を解決してください。
- 結果なし
- 在庫が空であることや発信者名が見つからないことは、通常の結果として処理してください。構文上有効な番号だからといって、すべてのサービスが利用できると想定しないでください。
- ネットワークのタイムアウトまたはサービス障害
- 読み取りには、バックオフを伴う回数制限付きの再試行を使用してください。購入、送信、登録の場合は、まず操作の状態を確認してください。受理済みのリクエストを再試行すると、課金対象の操作が重複する可能性があります。
冪等性のサポートは API ファミリーごとに異なります。Emergency API は再試行キーをサポートしていますが、それによって任意の v3 リクエストが冪等になるわけではありません。サポート対応のために、タイムスタンプ、返された ID、機密情報を伏せたレスポンスを保管してください。
アカウント専用リファレンスに進む
サインイン後のリファレンスでは、お客様の権限と有効なサービスに応じて操作が絞り込まれます。正確なホスト、認証情報の種類、リクエストフィールド、レスポンススキーマは、そのリファレンスの記載に従ってください。コンソールでは、購入やメッセージ送信を含む本番の操作を実行できます。