ルーティング情報を照会する

北米の電話番号のルーティング情報をリクエストします。取得可能なルーティングデータや通信事業者のデータを解釈するために使用してください。加入者の本人確認、番号の所有権、接続可能性、購入可能性の証明として使用しないでください。照会によりアカウントに料金が請求される場合があります。

リクエスト

有効化済みの API アカウントと、そのアカウントで許可されている送信元 IP アドレスを使用してください。国番号 1 を含む完全な番号を数字のみで指定してください。この例では環境変数と架空の番号を使用しています。ハンドラーは句読点や区切り記号を正規化しません。送信前に入力を検証してください。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/lrn/12025550123

レスポンス

説明のために一部のフィールドのみを示しています。取得できるフィールドはデータソースと番号の種類によって異なります。

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": {
    "lrn": "12025550123",
    "ocn": "0000",
    "local": 1,
    "ported": 0,
    "cost": "$0.00025"
  }
}

標準の照会では、返されるフィールド名が小文字に変換されます。データソースによっては、通信事業者、料金区域、所在地、管轄に関するフィールドが含まれる場合があります。レスポンスは、固定形式の完全な加入者記録ではありません。local フラグは数値の 1 または文字列の 0 になる場合があります。ハンドラーは、返されたルーティング番号と指定された電話番号を比較して ported を算出します。この値を、検証済みの完全な番号ポータビリティ履歴と解釈しないでください。

料金と再試行

確認したハンドラーは、完了処理の経路に到達して照会を記録すると、アカウントから $0.00025 を差し引きます。返される料金は通常、数値だけの金額ではなく、ドル記号を含む文字列です。冪等性キーは公開されていません。同じリクエストを繰り返すと、追加の料金が発生する場合があります。

プリペイドアカウントについては、コードは残高が 0.00025 以上あるかを確認します。現在、残高不足のメッセージには $5 と記載されていますが、これは実際の判定基準と一致しません。この失敗は残高不足による拒否として扱い、再試行する前にアカウント残高を確認してください。

失敗と不完全な成功

HTTP ステータスと JSON の status.code/status.msg の両方を確認してください。標準の照会結果が空の場合は、API コード 404 が返されます。API コード 403 は、プリペイド残高の不足を示す場合があります。

現在のフリーダイヤル番号のエラー処理経路では、有用なルーティングフィールドがなくても照会料金が差し引かれ、API コード 200 が返される場合があります。この場合、料金情報が不完全なこともあります。したがって、コード 200 だけでは、利用可能な照会結果が得られたとは判断できません。アプリケーションに必要なフィールドを検証し、不明確な請求はアカウントの請求記録と照合してください。結果が不完全な場合はサポートにお問い合わせください。

確認した実装では、入力の桁数によってフリーダイヤル番号の処理が異なります。国番号を含む完全な番号を数字のみで指定することを推奨します。必要なフリーダイヤル番号の対応範囲はサポートに確認してください。形式が不正な結果や不完全な結果に対して自動で再試行しないでください。また、その番号への発信が安全である、または許可されていると判断する根拠として、ルーティング照会に依存しないでください。