Kūrėjams

GET/v3/countries

Gauti katalogo šalių sąrašą (senasis formatas)

Senasis API galinis taškas, grąžinantis matomas šalis, susietas su specialiųjų numerių katalogu, kurį naudoja GET /v3/other/{isocode}, atsakymo turinyje, kurio formatas yra {code, data}. Numerių prieinamumas netikrinamas. Norėdami rasti šalis, kuriose yra prieinamų numerių, naudokite GET /v3/getcountries.

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

Šis senasis API galinis taškas grąžina {"code", "data"} formato turinį vietoj standartinio status/response apvalkalo. Jame pateikiamos matomos šalys, susietos su specialiųjų numerių katalogu, o numerių prieinamumas netikrinamas.

Naujoms integracijoms:

  • Naudokite GET /v3/getcountries norėdami rasti šalis, kuriose yra prieinamų numerių.
  • Naudokite GET /v3/other/{isocode} norėdami sužinoti, kokie specialiųjų numerių tipai iš tiesų siūlomi konkrečioje šalyje. Net jei šalis įtraukta į šį sąrašą, tos užklausos grąžintas jos katalogas gali būti tuščias.

Užklausa

Būtinas HTTP Basic autentifikavimas arba Bearer prieigos raktas (žr. „Autentifikavimas ir API atsakymai“). Jei autentifikavimas nepavyksta, prieš atliekant paiešką grąžinamas HTTP 401 atsakymas standartiniame apvalkale.

GET be parametrų ir be užklausos turinio.

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

Atsakymas

Senojo formato turinys be standartinio apvalkalo: {code: 200, data: [...]}. Nėra objekto status ir laukų msg ar results. Lauke data pateikiamas šalių sąrašas, kurio tvarka negarantuojama. Laukai: countrycode (šalies telefono kodas be '+'), name, description (ta pati reikšmė kaip name), isocode, latitude ir longitude. Laukų is_mobile, sms_coverage ar next_function nėra. Šalis įtraukiama į sąrašą, kai ji yra matoma ir susieta su specialiųjų numerių katalogu. Numerių prieinamumas netikrinamas, todėl į sąrašą įtrauktoje šalyje šiuo metu gali nebūti prieinamų numerių. Jei nė viena šalis neatitinka sąlygų, data reikšmė yra null.

Iliustracinis atsakymo struktūros pavyzdys; tai nėra faktiniai paskyros duomenys ar šiuo metu galiojantis kainos pasiūlymas.

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

Klaidos

  • 401: Nepateikti autentifikavimo duomenys arba autentifikavimas nepavyko. Grąžinama su HTTP status 401 standartiniame status/response apvalkale, o ne senojo formato turinyje.

Prieinamumas ir šalutinis poveikis

  • Atliekama tik paieška. Nieko nerezervuojama, neužsakoma ir nekeičiama.