開発者

GET/v3/nanpacheck/{number}

北米電話番号の割り当て範囲を確認

電話番号を割り当てテーブルと照合します。ただし、加入者の確認や番号の利用可否の検証にはなりません。

このページの内容
  1. 割り当てテーブルの対象範囲を確認
  2. リクエスト
  3. レスポンス
  4. エラー
  5. 料金と次の手順

割り当てテーブルの対象範囲を確認

北米の電話番号がMultiTELの割り当てテーブル内のプレフィックスと一致するかを確認し、対応する市、州、国を取得します。これはプレフィックステーブルの検索です。加入者が現在サービスを利用していること、番号が割り当て済みであること、その番号がご利用のアカウントに属すること、または注文可能であることを確認するものではありません。

リクエスト

有効化済みのAPIアカウントと、許可された送信元IPアドレスを使用してください。この例では、環境変数から取得したHTTP Basic認証情報と架空の電話番号を使用しています。リクエストボディは不要です。

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

1で始まる十一桁の北米電話番号を使用することを推奨します。ハンドラーは数字以外の文字を除去し、十桁の入力には先頭に1を付加します。それ以外の桁数は拒否されます。この正規化では北米の電話番号規則をすべて検証するわけではないため、テーブルとの照合に成功しても、番号の妥当性が網羅的に検証されたことにはなりません。

レスポンス

フィールドの値は説明用の例にすぎず、実際の割り当てテーブルから取得した結果ではありません。

{
  "status": {
    "code": 200,
    "msg": "12025550123"
  },
  "response": {
    "number": "12025550123",
    "npanxx": "1202555",
    "city": "Example City",
    "state": "DC",
    "country": "US"
  }
}
割り当て照合結果のフィールド
フィールド意味
number数字のみになるように正規化された入力値。
npanxx一致した保存済みプレフィックス。ハンドラーは、国番号・市外局番・局番からなる七桁のプレフィックスを優先し、一致しない場合は国番号・市外局番からなる四桁のプレフィックスで照合することがあります。このフィールドが常に局番まで特定しているとは限りません。
city, state, country一致した割り当てプレフィックスのメタデータ。これらのフィールドは、加入者の現在の物理的な所在地や、番号ポータビリティによる移転後の現在の通信事業者を特定するものではありません。

エラー

HTTP 200だけで判断せず、JSONのstatus.codeを確認してください。メッセージがNot part of NANPAであるAPIコード404は、サービスが使用するテーブル内に一致するプレフィックスがなかったことを意味します。世界各地の番号管理機関による確定的な判定を示すものではありません。APIコード500は、桁数が不正な場合、または番号が指定されていない場合に使用されます。

料金と次の手順

レビュー対象のハンドラーはローカルの割り当てテーブルに問い合わせを行い、アカウント残高からの引き落としや外部への照会は行いません。このハンドラーによる検索料金は発生しません。注文可能な在庫を探すには、注文可能な電話番号の検索を使用してください。名前の照会、ルーティングの照会、番号の注文はそれぞれ別の操作であり、各操作に対応するアカウントの料金が適用されます。