REST API ドキュメント
緊急通報 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 連携設定で管理します。
番号を登録せずにカバレッジを読み取る
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multi.tel/emergency/coverage?environment=production"https://api.multitel.net/emergency もサポートされています。どちらの緊急通報用ベース URL にも /v3 は含まれません。カバレッジには対象国、サポートされている番号タイプ、料金が一覧表示されます。北米の E911 の利用資格は登録時に確認されます。
{
"code": 200,
"message": "",
"environment": "production",
"requestId": "EXAMPLE_REQUEST_ID",
"data": {}
}これはエンベロープの形式のみを示しています。各操作の data スキーマは、公開されている Emergency API ガイドで確認してください。
登録し、ステータスを追跡してから、発信を設定する
- 米国/カナダおよびその他のサポートされている北米の E911 地域では、番号、E911 の住所、必要な同意確認を提供してください。北米の E911 は本番環境のみです。
- サポートされている、所有している国際番号については、保存済みの Document の参照、またはエンドユーザーの本人情報と住所のいずれかを提供してください。まず、国と番号タイプごとの要件を確認してください。
POST /registrationsリクエストを 1 回送信します。任意のIdempotency-Keyは、1 つの論理的な変更操作を識別します。再試行の際は、これと正確に同じペイロードを保持してください。GET /registrations/:numberを読み取ります。ライフサイクル、pending、actionRequiredを確認し、必要な修正を行ってください。受理された、または保留中であることは、サービスが有効であることを意味しません。- アクティベーション後に、正しい緊急通報用の発信者 ID と、国ごとのダイヤルルートを設定します。サービスの、緊急通報ではない確認手順を使用してください。
国際サンドボックスの登録は分離されており、実際の緊急通報の発信を有効にしません。北米の E911 にはメインアカウントの認証情報が必要です。国際サブアカウントの限定的なサポートについては、ガイドで説明しています。
エラーと再試行の扱い
- 認証または権限の失敗
- API 認証情報の有効状態、許可されているサービス、送信元 IP の制限を確認してください。ポータルのセッション Cookie は連携用の認証情報ではありません。
- クレジット不足または承認の未完了
- 操作を繰り返す前に、アカウント残高、送信の承認、または書類要件を解決してください。
- 結果なし
- 在庫が空であることや発信者名が見つからないことは、通常の結果として処理してください。構文上有効な番号だからといって、すべてのサービスが利用できると想定しないでください。
- ネットワークのタイムアウトまたはサービス障害
- 読み取りには、バックオフを伴う回数制限付きの再試行を使用してください。購入、送信、登録の場合は、まず操作の状態を確認してください。受理済みのリクエストを再試行すると、課金対象の操作が重複する可能性があります。
冪等性のサポートは API ファミリーごとに異なります。Emergency API は再試行キーをサポートしていますが、それによって任意の v3 リクエストが冪等になるわけではありません。サポート対応のために、タイムスタンプ、返された ID、機密情報を伏せたレスポンスを保管してください。
アカウント専用リファレンスに進む
サインイン後のリファレンスでは、お客様の権限と有効なサービスに応じて操作が絞り込まれます。正確なホスト、認証情報の種類、リクエストフィールド、レスポンススキーマは、そのリファレンスの記載に従ってください。コンソールでは、購入やメッセージ送信を含む本番の操作を実行できます。