Programeri

GET/v3/getcountries

Popis država s brojevima na zalihi

Vraća vidljive države koje trenutačno imaju barem jedan prefiks s brojevima na zalihi. Svaki zapis uključuje pozivni broj države, ISO oznaku, oznake mobilnih brojeva i SMS pokrivenosti na razini države, koordinate i poveznicu next_function na područja pokrivenosti te države.

Na ovoj stranici
  1. Zahtjev
  2. Odgovor
  3. Pogreške
  4. Dostupnost i popratni učinci

Ovdje započnite pretraživanje lokalnih brojeva. Popis sadrži samo države koje trenutačno imaju brojeve na zalihi. Time se ništa ne rezervira.

  • Proslijedite isocode funkciji getareas, funkciji getstates (samo za US i CA) ili funkciji other.
  • next_function uvijek upućuje na v3/getareas/{isocode}. Za Sjedinjene Američke Države i Kanadu možete pozvati getstates najprije kako biste suzili pretragu prema saveznoj državi ili pokrajini.
  • is_mobile i sms_coverage oznake su na razini države i nisu jamstva za svaki pojedini broj. Za Sjedinjene Američke Države is_mobile ima vrijednost 0 osim ako su na vašem računu omogućeni mobilni brojevi iz SAD-a.
  • Države čija je pokrivenost dostupna isključivo po narudžbi nisu na popisu. I dalje možete pozvati getareas ili other izravno za državu koja nije na popisu.
  • Ako vam je potreban određeni redoslijed, sami sortirajte popis.

Ako nijedna država ne zadovoljava uvjete, response ima vrijednost null i status.code ima vrijednost 200.

Zahtjev

Obavezno: HTTP Basic autentifikacija ili token Bearer (pogledajte Autentifikacija i odgovori API-ja). Ako autentifikacija ne uspije, vraća se HTTP 401 prije izvršavanja pretrage.

GET bez tijela zahtjeva. Jedini je parametar neobavezni pid, koji se šalje u nizu upita.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Parametri upita
NazivVrstaObaveznoOpis
pidstringNeNapredni i neobavezni parametar. Sužava popis na države označene za jedan izvor zaliha. Upotrebljavajte samo vrijednost koju vam je dostavio MultiTEL, u brojčanom obliku ili heksadekadskom obliku od 32 znaka, a za uobičajenu upotrebu izostavite ovaj parametar. pid ne sužava provjeru zaliha opisanu u odgovoru. Neprepoznate vrijednosti, nula i vrijednosti koje ova krajnja točka ne prihvaća zanemaruju se bez pogreške; popis tada obuhvaća sve podržane izvore.

Odgovor

Standardna omotnica odgovora. U slučaju uspjeha, status.code ima vrijednost 200, status.msg ima vrijednost 'Results: N', status.results ima vrijednost N, a response je popis država bez zajamčenog redoslijeda. Polja: countrycode (pozivni broj države bez znaka '+'); name (naziv države); description (ista vrijednost kao name); isocode (oznaka prema normi ISO 3166-1 alpha-2); is_mobile (0 ili 1, kataloška oznaka na razini države, uvijek 0 za US osim ako su na vašem računu omogućeni mobilni brojevi za US); sms_coverage (0 ili 1, kataloška oznaka na razini države); latitude i longitude (koordinate države); next_function ('v3/getareas/{isocode}'). Država se navodi samo ako je vidljiva i barem jedan njezin prefiks trenutačno ima brojeve na zalihi u bilo kojem izvoru zaliha. Države čija je pokrivenost u cijelosti dostupna samo po narudžbi (bez zaliha) nisu na popisu. Ova provjera zaliha šira je od filtara koje primjenjuje getareas, pa se za državu s popisa ondje povremeno može vratiti 'No areas found'. Ako nijedna država ne zadovoljava uvjete, status.code ima vrijednost 200, status.msg ima vrijednost 'Results: 0', polje status.results nije prisutno, a response ima vrijednost null.

Ogledna struktura odgovora; ne prikazuje stvarne podatke računa ni trenutačnu ponudu cijene.

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

Pogreške

  • 401: Autentifikacija nedostaje ili nije uspjela. Šalje se uz HTTP status 401 (pogledajte Autentifikacija i odgovori API-ja).

Dostupnost i popratni učinci

  • Samo pretraga. Ništa se ne rezervira, ne naručuje niti mijenja.
  • Rezultati odražavaju stanje zaliha u trenutku slanja zahtjeva i mogu se promijeniti između poziva.