REST API ドキュメント
最初の MultiTEL 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.multitel.net/v3/getbalance"communications v3 API は、JSON 本文の中にアプリケーションの処理結果を返します。response を読み取る前に、HTTP ステータスと status.code を確認してください。拒否されたリクエストには response オブジェクトが含まれない場合があります。コード値は文字列の場合も数値の場合もあります。
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}これは架空の例であり、実際のアカウント残高ではありません。金額は小数の値として扱ってください。拒否されたリクエストを調査する際は、認証情報を取り除いたうえで、サーバーが返したレスポンスメッセージを保管してください。
請求データを正しく使う
残高レスポンスには、現在の残高、通貨、支払条件が含まれます。今後の通話の料金や、完全な請求書の内容は含まれません。それらについては、対応する料金および利用状況の操作を使用してください。既存の番号は、現在のカタログとは異なるプランである場合があります。
次の連携を選ぶ
LRN ルーティング検索 REST API
北米の電話番号について、ルーティング番号と利用可能なキャリア情報を一定の単価で検索できます。
連携ガイドを読む →電話番号 REST API
利用可能な国と番号を検索し、提供内容の全体を確認し、所有している番号を管理できます。
連携ガイドを読む →SMS・MMS REST API
承認済みのアプリケーションメッセージを送信し、受付、配信イベント、セグメント分割、課金を処理できます。
連携ガイドを読む →緊急通報 REST API
番号とサービス住所を登録し、有効化の状況を確認し、所在地の変更に合わせてレコードを維持できます。
連携ガイドを読む →アカウント・請求 REST API
承認済みの連携で利用できる残高と請求情報を取得できます。
連携ガイドを読む →CNAM およびルーティング情報の検索
発信者名の取得、検索ティアの違い、番号ルーティング情報の利用方法を確認できます。
CNAM REST リファレンス →ホスト型 PBX
まず、利用可能なサービスプランと、設定対象のテナントを確認してください。
ホスト型 PBX サービスプラン API →エラーと再試行の扱い
- 認証または権限の失敗
- API 認証情報の有効状態、許可されているサービス、送信元 IP の制限を確認してください。ポータルのセッション Cookie は連携用の認証情報ではありません。
- クレジット不足または承認の未完了
- 操作を繰り返す前に、アカウント残高、送信の承認、または書類要件を解決してください。
- 結果なし
- 在庫が空であることや発信者名が見つからないことは、通常の結果として処理してください。構文上有効な番号だからといって、すべてのサービスが利用できると想定しないでください。
- ネットワークのタイムアウトまたはサービス障害
- 読み取りには、バックオフを伴う回数制限付きの再試行を使用してください。購入、送信、登録の場合は、まず操作の状態を確認してください。受理済みのリクエストを再試行すると、課金対象の操作が重複する可能性があります。
冪等性のサポートは API ファミリーごとに異なります。Emergency API は再試行キーをサポートしていますが、それによって任意の v3 リクエストが冪等になるわけではありません。サポート対応のために、タイムスタンプ、返された ID、機密情報を伏せたレスポンスを保管してください。
アカウント専用リファレンスに進む
サインイン後のリファレンスでは、お客様の権限と有効なサービスに応じて操作が絞り込まれます。正確なホスト、認証情報の種類、リクエストフィールド、レスポンススキーマは、そのリファレンスの記載に従ってください。コンソールでは、購入やメッセージ送信を含む本番の操作を実行できます。