開発者

GET/v3/countries

カタログに掲載された国の一覧を取得する(従来形式)

GET /v3/other/{isocode} が使用する特殊番号カタログに関連付けられた、表示対象の国を、{code, data} 形式の本文で返す従来のエンドポイントです。在庫は確認しません。番号の在庫がある国を探すには、GET /v3/getcountries を使用してください。

このページの内容
  1. リクエスト
  2. レスポンス
  3. エラー
  4. 提供状況と副作用

この従来のエンドポイントは、{"code", "data"} 形式の本文を返します。標準の status/response エンベロープは使用しません。特殊番号カタログに関連付けられた、表示対象の国を一覧で返します。在庫は確認しません。

新規に連携を実装する場合:

  • 次のエンドポイントを使用してください:GET /v3/getcountries。番号の在庫がある国を探せます。
  • 次のエンドポイントを使用してください:GET /v3/other/{isocode}。その国で実際に提供されている特殊番号の種類を確認できます。この一覧に掲載されている国でも、そのエンドポイントでは空のカタログが返されることがあります。

リクエスト

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

GET を使用します。パラメーターも本文もありません。

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

レスポンス

標準エンベロープを使用しない従来形式の本文:{code: 200, data: [...]}。status オブジェクト、および msg、results フィールドはありません。data には国の一覧が含まれますが、順序は保証されません。フィールドは、countrycode('+' を含まない国番号)、name、description(name と同じ値)、isocode、latitude、longitude です。is_mobile、sms_coverage、next_function フィールドはありません。表示対象であり、かつ特殊番号カタログに関連付けられている国が一覧に掲載されます。在庫は確認しないため、掲載されている国でも、現在利用できる番号がない場合があります。条件に該当する国がない場合、data は null になります。

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

{
  "code": 200,
  "data": [
    {
      "countrycode": "33",
      "name": "France",
      "description": "France",
      "isocode": "FR",
      "latitude": "46.0000",
      "longitude": "2.0000"
    }
  ]
}

エラー

  • 401:認証情報がないか、認証に失敗しました。HTTP status 401 とともに、標準の status/response エンベロープで返されます。従来形式の本文では返されません。

提供状況と副作用

  • 情報の検索のみを行います。予約、注文、変更は一切行いません。