Kūrėjams

GET/v3/getcountries

Šalių, kuriose yra turimų numerių, sąrašas

Grąžina matomas šalis, kuriose šiuo metu yra turimų numerių bent su vienu numerių prefiksu. Kiekviename įraše pateikiamas šalies telefono kodas, ISO kodas, šalies lygmens mobiliojo ryšio ir SMS požymiai, koordinatės ir next_function nuoroda į šalies aprėpties sritis.

Šiame puslapyje
  1. Užklausa
  2. Atsakymas
  3. Klaidos
  4. Prieinamumas ir šalutinis poveikis

Vietinių numerių paiešką pradėkite čia. Sąraše pateikiamos tik šalys, kuriose šiuo metu yra turimų numerių. Ši užklausa nieko nerezervuoja.

  • Perduokite isocode funkcijai getareas, funkcijai getstates (tik US ir CA) arba funkcijai other.
  • next_function visada nurodo v3/getareas/{isocode}. Jungtinėms Amerikos Valstijoms ir Kanadai pirmiausia galite iškviesti getstates ir taip susiaurinti paiešką pagal valstiją arba provinciją.
  • is_mobile ir sms_coverage yra šalies lygmens požymiai, o ne garantijos kiekvienam numeriui. Jungtinėms Amerikos Valstijoms is_mobile reikšmė yra 0, nebent jūsų paskyroje įjungta galimybė naudoti JAV mobiliojo ryšio numerius.
  • Šalys, kuriose numeriai prieinami tik pagal užsakymą, į sąrašą neįtraukiamos. Į sąrašą neįtrauktai šaliai vis tiek galite tiesiogiai iškviesti getareas arba other.
  • Jei reikia tam tikros tvarkos, sąrašą surikiuokite patys.

Jei nė viena šalis neatitinka sąlygų, response reikšmė yra null, o status.code reikšmė yra 200.

Užklausa

Būtina: HTTP Basic autentifikacija arba Bearer prieigos raktas (žr. „Autentifikacija ir API atsakymai“). Jei autentifikacija nepavyksta, HTTP 401 atsakymas grąžinamas dar prieš atliekant paiešką.

GET užklausa be turinio. Vienintelis parametras yra neprivalomas pid, perduodamas užklausos eilutėje.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Užklausos parametrai
PavadinimasTipasPrivalomasAprašymas
pidstringNeIšplėstinis, neprivalomas parametras. Apriboja sąrašą šalimis, pažymėtomis kaip priklausančiomis vienam numerių atsargų šaltiniui. Naudokite tik „MultiTEL“ pateiktą skaitinę arba 32 simbolių šešioliktainę reikšmę; įprastai naudodami šį parametrą praleiskite. pid neapriboja atsakymo aprašyme nurodytos atsargų patikros. Neatpažintos reikšmės, nulis ir reikšmės, kurių šis API iškvietimo taškas nepriima, ignoruojamos negrąžinant klaidos; tokiu atveju sąrašas apima visus palaikomus šaltinius.

Atsakymas

Standartinė atsakymo struktūra. Sėkmės atveju status.code reikšmė yra 200, status.msg reikšmė yra 'Results: N', status.results reikšmė yra N, o response yra šalių sąrašas, kurio tvarka negarantuojama. Laukai: countrycode (šalies telefono kodas be '+'); name (šalies pavadinimas); description (ta pati reikšmė kaip name); isocode (ISO 3166-1 alpha-2 kodas); is_mobile (0 arba 1, šalies lygmens katalogo požymis; šaliai US visada 0, nebent jūsų paskyroje įjungta galimybė naudoti US mobiliojo ryšio numerius); sms_coverage (0 arba 1, šalies lygmens katalogo požymis); latitude ir longitude (šalies koordinatės); next_function ('v3/getareas/{isocode}'). Šalis įtraukiama į sąrašą tik jei ji yra matoma ir bent su vienu jos prefiksu šiuo metu yra turimų numerių bent viename numerių atsargų šaltinyje. Šalys, kuriose visi numeriai prieinami tik pagal užsakymą (atsargų nėra), į sąrašą neįtraukiamos. Ši atsargų patikra yra platesnė nei funkcijos getareas taikomi filtrai, todėl į sąrašą įtrauktai šaliai ši funkcija kartais gali grąžinti 'No areas found'. Jei nė viena šalis neatitinka sąlygų, status.code reikšmė yra 200, status.msg reikšmė yra 'Results: 0', lauko status.results nėra, o response reikšmė yra null.

Pavyzdinė atsakymo struktūra; tai nėra faktiniai paskyros duomenys ar dabartinis kainos pasiūlymas.

{
  "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"
    }
  ]
}

Klaidos

  • 401: nepateikti autentifikacijos duomenys arba autentifikacija nepavyko. Grąžinama su HTTP būsenos kodu 401 (žr. „Autentifikacija ir API atsakymai“).

Prieinamumas ir šalutinis poveikis

  • Atliekama tik paieška. Ji nieko nerezervuoja, neužsako ir nekeičia.
  • Rezultatai atspindi užklausos metu turimas numerių atsargas ir tarp iškvietimų gali pasikeisti.