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.multitel.net/v3/getcountries"v3 のレスポンスには、status と response 配列が含まれます。国のエントリーには、isocode、name、countrycode、機能情報、next_function が含まれます。利用可否はアカウントと在庫によって異なります。国が掲載されていても、すべてのプレフィックスや番号タイプの在庫があることを約束するものではありません。
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}検索からアクティベーションまで
- 対応する地域の操作を使用して、国、必要な場合は下位の地域区分、エリア、番号タイプを選択します。
- 選択した番号の初期費用、月額料金、利用料金、チャネル数、プランに含まれる利用枠、登録要件を確認します。
- 必要なエンドユーザーの書類を提出し、そのステータスを確認します。承認されるまで、番号が保留のままになる場合があります。
- 在庫と料金の選択内容を正確に指定して、注文は 1 回だけ行います。レスポンスの結果が不確かな場合は、別の注文を送信する前に、ご自身の在庫を確認してください。
- 音声のルーティングとメッセージの配信を個別に設定し、そのうえで、意図したルート全体をテストします。
エラーと再試行の扱い
- 認証または権限の失敗
- API 認証情報の有効状態、許可されているサービス、送信元 IP の制限を確認してください。ポータルのセッション Cookie は連携用の認証情報ではありません。
- クレジット不足または承認の未完了
- 操作を繰り返す前に、アカウント残高、送信の承認、または書類要件を解決してください。
- 結果なし
- 在庫が空であることや発信者名が見つからないことは、通常の結果として処理してください。構文上有効な番号だからといって、すべてのサービスが利用できると想定しないでください。
- ネットワークのタイムアウトまたはサービス障害
- 読み取りには、バックオフを伴う回数制限付きの再試行を使用してください。購入、送信、登録の場合は、まず操作の状態を確認してください。受理済みのリクエストを再試行すると、課金対象の操作が重複する可能性があります。
冪等性のサポートは API ファミリーごとに異なります。Emergency API は再試行キーをサポートしていますが、それによって任意の v3 リクエストが冪等になるわけではありません。サポート対応のために、タイムスタンプ、返された ID、機密情報を伏せたレスポンスを保管してください。
アカウント専用リファレンスに進む
サインイン後のリファレンスでは、お客様の権限と有効なサービスに応じて操作が絞り込まれます。正確なホスト、認証情報の種類、リクエストフィールド、レスポンススキーマは、そのリファレンスの記載に従ってください。コンソールでは、購入やメッセージ送信を含む本番の操作を実行できます。