番号の在庫がある国の一覧を取得

市内番号を探す際は、ここから始めてください。一覧には、現在番号の在庫がある国のみが含まれます。この操作では何も予約されません。

• 渡す値はisocode、渡し先はgetareas、getstates（USとCAのみ）、またはotherです。
• next_functionが常に指す先はv3/getareas/{isocode}です。米国とカナダについては、まずgetstatesを呼び出して、州で絞り込むことができます。
• is_mobileとsms_coverageは国単位のフラグであり、すべての番号について保証するものではありません。米国の場合、is_mobileは0です。ただし、アカウントで米国の携帯電話番号の利用が有効になっている場合を除きます。
• 注文による提供のみの国は一覧に含まれません。一覧にない国についても、getareasまたはotherを直接呼び出すことができます。
• 特定の順序が必要な場合は、取得した一覧をご自身で並べ替えてください。

条件を満たす国がない場合、responseはnullとなり、status.codeは200となります。

リクエスト

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

本文なしのGETリクエストです。パラメーターは任意のpidのみで、クエリ文字列で送信します。

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

レスポンス

標準のレスポンス構造です。成功時は、status.codeが200、status.msgが'Results: N'、status.resultsがNとなり、responseは国の一覧になります。並び順は保証されません。フィールド：countrycode（'+'を含まない国番号）、name（国名）、description（nameと同じ値）、isocode（ISO 3166-1 alpha-2コード）、is_mobile（0または1の国単位のカタログフラグ。常に0となるのはUSの場合で、アカウントでUSの携帯電話番号の利用が有効になっている場合を除きます）、sms_coverage（0または1の国単位のカタログフラグ）、latitudeとlongitude（国の座標）、next_function（'v3/getareas/{isocode}'）。国が一覧に含まれるのは、その国が表示対象であり、少なくとも一つの番号プレフィックスについて、いずれかの在庫供給元に現在在庫がある場合のみです。すべてが注文による提供のみで、在庫がない国は一覧に含まれません。この在庫確認の対象範囲はgetareasが適用するフィルターより広いため、一覧に含まれる国でも、そちらでは'No areas found'が返されることがあります。条件を満たす国がない場合、status.codeは200、status.msgは'Results: 0'となり、status.resultsフィールドは存在せず、responseはnullとなります。

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

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

エラー

• 401：認証情報がないか、認証に失敗しました。HTTPステータス401で返されます（「認証とAPIレスポンス」を参照）。

提供状況と副作用

• 検索のみを行います。予約、注文、変更は一切行いません。
• 結果はリクエスト時点の在庫状況を反映しており、呼び出すたびに変わる可能性があります。