Разработчици

GET/v3/getcountries

Списък на държавите с налични номера

Връща видимите държави, които към момента имат поне един префикс с налични номера. Всеки запис включва международния телефонен код, ISO кода, признаците за мобилни номера и SMS на ниво държава, координатите и връзка next_function към областите на държавата.

На тази страница
  1. Заявка
  2. Отговор
  3. Грешки
  4. Наличност и странични ефекти

Започнете търсенето на местни номера оттук. Списъкът съдържа само държави, в които към момента има налични номера. Това не резервира нищо.

  • Подайте 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'
Параметри в низа на заявката
ИмеТипЗадължителенОписание
pidstringНеНезадължителен параметър за разширена употреба. Ограничава списъка до държавите, обозначени за един източник на номера. Използвайте само стойност, предоставена от MultiTEL, в числов вид или като 32-знаков шестнадесетичен низ, и пропускайте параметъра при обичайна употреба. pid не ограничава проверката за наличност, описана в отговора. Неразпознатите стойности, нулата и стойностите, които тази крайна точка не приема, се игнорират без грешка; тогава списъкът обхваща всички поддържани източници.

Отговор

Стандартна обвивка на отговора. При успех 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“).

Наличност и странични ефекти

  • Само справка. Не резервира, не поръчва и не променя нищо.
  • Резултатите отразяват наличността към момента на заявката и могат да се променят между извикванията.