番号の在庫がある米国の州またはカナダの州を一覧表示

米国またはカナダで番号を探す際、この任意の手順を使うと州で絞り込めます。受け付けるのは US と CA のみです。

• 各項目は、リクエスト時点でその州に在庫があるプレフィックスを示します。
• 次のリンクをたどってください: next_function。その州のエリアを一覧表示できます。このリンクにはすでに state フィルターが含まれていますが、pid は含まれていません。
• エリア検索では、州情報の照合方法が少し異なります。その州の next_function の戻り値が No areas found の場合は、代わりに getareas を州の指定なしで呼び出してください。
• まず status.code を確認してから、response を読み取ってください。サポート対象外の国、または条件に一致する在庫がない国の場合、コード 404 が返されますが、それに対応する HTTP ステータスは設定されません。
• コード 200 でリストが空の場合、在庫は存在しますが州情報がありません。getareas を州の指定なしで呼び出してください。

リクエスト

必須: HTTP Basic 認証または Bearer トークン（「認証と API レスポンス」を参照）。認証に失敗した場合、検索を実行する前に HTTP 401 が返されます。

GET を使用し、パスに isocode を指定します。そのパスセグメントを省略した場合は、代わりにフォームエンコードされた isocode フィールドが読み取られます。任意の pid はクエリ文字列で送信します。

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getstates/US'

レスポンス

標準の共通レスポンス形式です。成功時は status.code が 200、status.msg が空、status.results が項目数になります。response は、name（大文字と小文字を区別しない）、次に state コードの順で並べ替えられたリストです。フィールド: state（プレフィックスの州データから取得した州コード。通常は英字二文字で、一般的でない値も変更せずに返します）、name（カタログ上の名前。カタログに名前がない場合はコード）、country_iso、available（集計対象のプレフィックス全体の在庫総数。常に 0 より大きい値）、prefix_count（集計した在庫のあるプレフィックスの数）、is_mobile（集計対象に携帯電話対応のプレフィックスがあれば 1。US では、アカウントで米国の携帯電話番号が有効になっていない限り常に 0）、sms_coverage（集計対象に SMS 対応のプレフィックスがあれば 1）、returns_numbers（集計対象に番号返却フラグが設定されているか、そのフラグの値が未設定のプレフィックスがあれば 1）、next_function（'v3/getareas/{isocode}?state={state}'）。在庫のあるプレフィックスが存在しても、いずれにも州情報がない場合、結果は status.code が 200、リストが空、status.results が 0 になります。

レスポンス形式を示す例です。実際のアカウントデータや現時点の見積もりではありません。

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

エラー

• 500: msg 'ISO Code parameter is required': isocode が指定されていないか、空です。これは修正可能なリクエストエラーです。対応する HTTP ステータスは設定されないため、status.code を読み取ってください。
• 404: msg 'getstates is only available for US and CA': 対象外の国コードが指定されています。対応する HTTP ステータスは設定されません。
• 404: msg 'No states found': 国および供給元のフィルターに一致する在庫のあるプレフィックスがありません。対応する HTTP ステータスは設定されません。
• 401: 認証情報がないか、認証に失敗しました。HTTP ステータス 401 とともに返されます。

在庫状況と副作用

• 検索のみを行います。予約、注文、変更は一切行いません。available は情報提供のみを目的としており、番号を確保するものではありません。