Programeri

GET/v3/getprefixes/{area_id}

Popis prefiksa za područje

Dohvatite popis prefiksa brojeva koji se nude za određeno područje, provjerite dostupnost i oznake registracije te pronađite sljedeći korak za pregled ponude ili naručivanje. Cijene nisu uključene.

Na ovoj stranici
  1. Prije početka
  2. Tumačenje rezultata
  3. Odaberite sljedeći korak
  4. Napredne mogućnosti prikaza
  5. Zahtjev
  6. Odgovor
  7. Pogreške
  8. Dostupnost i popratni učinci

Prije početka

Odaberite područje putem getareas. Kopirajte ID područja iz odgovora ili vraćenog polja next_function. Za područje u SAD-u ili Kanadi upotrijebite getstates ako želite suziti rezultate na jednu saveznu državu ili pokrajinu.

Tumačenje rezultata

Provjerite status.code u tijelu JSON odgovora, kao i HTTP status. Uspješni rezultati nalaze se u polju response koje je niz. Zadani odgovor razvrstan je po nazivu. available je procjena, a oznake u katalogu ne zamjenjuju provjeru stvarnih mogućnosti odabranog broja i zahtjeva za registraciju.

Odaberite sljedeći korak

Upotrijebite negrupirani rezultat. Kada je vrijednost polja returns_numbers jednaka 1, vraćeno polje next_function upućuje na pretraživanje brojeva. Kada je vrijednost 0, brojevi se dodjeljuju pri naručivanju, a putanja upućuje na operaciju naručivanja. Prije slanja zahtjeva provjerite operaciju i njezine zahtjeve: zahtjev za naručivanje može teretiti vaš račun. Nemojte automatski slati zahtjeve na sve vraćene putanje.

Ovdje cijena nije uključena. Prije kupnje pregledajte odgovarajuću ponudu, potrebne dokumente i upute za naručivanje. Sačuvajte vraćene ID-ove pojedinačnih prefiksa i ponuda umjesto da ih sami sastavljate iz prikazanog telefonskog prefiksa.

Napredne mogućnosti prikaza

compact=1 vraća nasumično poredan uzorak od najviše 100 redaka, a ne stranicu većeg skupa rezultata. Grupiranje stvara sažete retke i sintetičke ID-ove; za odabir pojedinačnog prefiksa upotrijebite uobičajeni negrupirani odgovor. Nemojte na temelju uzorkovanih ili grupiranih rezultata tvrditi da prikazuju cjelokupnu ponudu ili točne mogućnosti.

Zahtjev

Upotrijebite vjerodajnice svojeg omogućenog API računa putem HTTPS-a. Podržani su autentifikacija Basic i omogućeni tokeni vrste bearer za API račun; primjenjuju se ograničenja računa.

Upotrijebite GET i pošaljite neobavezne parametre u nizu upita. Nemojte se oslanjati na zamjensko čitanje parametara iz tijela obrasca.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"
Parametri putanje
NazivTipObaveznoOpis
area_idstringDaKopirajte identifikator područja iz odgovora funkcije getareas ili njezina polja next_function. Tretirajte ga kao neprozirnu vrijednost; nemojte ga sami sastavljati ni izračunavati funkcijom sažimanja.
Parametri upita
NazivTipObaveznoOpis
statestringNeSamo za područja u državama s oznakama US i CA. Upotrijebite oznaku savezne države ili pokrajine iz odgovora funkcije getstates ili njezin puni naziv. Oznake ne razlikuju velika i mala slova; u nazivima se zanemaruju razlike između velikih i malih slova te ponovljeni bjeline. Za drugu državu ili neprepoznatu vrijednost koja nije prazna API vraća pogrešku.
compactstringNeNeobavezni način uzorkovanja: 1, true ili on. Rezultati su nasumično poredani i sadrže najviše 100 redaka. Izostavite ovaj parametar za potpuni popis rezultata; ova krajnja točka nema stranice ni pokazivač za nastavak dohvaćanja.
groupintegerNeNapredni sažeti prikazi: vrijednosti od 1 do 6 spajaju retke i vraćaju maskirane prefikse za prikaz. UUID-ovi grupa sintetički su i ne mogu se upotrebljavati umjesto ID-ova pojedinačnih prefiksa. Prije odabira prefiksa za pretraživanje brojeva ili naručivanje pošaljite zahtjev bez grupiranja. Za uobičajeni postupak izostavite ovaj parametar.
pidstringNeNeobavezni selektor ponude koji dostavlja MultiTEL, u brojčanom ili podržanom heksadekadskom obliku duljine 32 znaka. Za uobičajenu upotrebu izostavite ga. Neprepoznate vrijednosti zanemaruju se bez obavijesti. Vrijednost nije telefonski prefiks ni ID tarifnog plana.

Odgovor

Standardna JSON omotnica status/response. Polje status.results broji vraćene retke, uključujući rezultate uzorkovanja ili grupiranja. Polje response sadrži objekte prefiksa. Polja s cijenama ne vraćaju se. U uobičajenom negrupiranom odgovoru uuid je ID prefiksa; area_uuid i country_uuid vraćeni su identifikatori; prefix i name podaci su za prikaz; available je procjena dostupnosti, a ne rezervacija; needs_registration i restrictions opisuju podatke o registraciji; sms_coverage, is_mobile i number_type naznake su iz kataloga, a ne jamstvo određene mogućnosti broja. Polje number_type može biti prazno ili sadržavati drugi niz znakova iz kataloga, stoga nemojte zahtijevati fiksni skup dopuštenih vrijednosti. Polje state niz je znakova i može biti prazno ili sadržavati oblikovanje iz kataloga. Polja latitude i longitude mogu biti prazna. Polja metered i overflow oznake su iz kataloga, a ne novčani iznosi. Polje returns_numbers odabire putanju za dohvat popisa brojeva (1) ili putanju za dodjelu broja pri naručivanju (0). Polje next_function identificira tu sljedeću putanju. Grupirani odgovori dodatno sadrže objedinjene značajke, uključujući zamjenske vrijednosti značajki; nemojte ih tumačiti kao provjerene mogućnosti svakog broja.

Ogledna struktura odgovora; ne predstavlja podatke računa uživo ni aktualnu ponudu.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Pogreške

  • 404: Invalid area ID: dohvatite aktualni ID područja pregledom ponude.
  • 404: State filter is only available for US and CA: za ostale države izostavite state.
  • 404: Invalid state: upotrijebite saveznu državu ili pokrajinu koju za ovu državu vraća getstates.
  • 404: No prefixes found: nisu vraćeni odgovarajući retci iz kataloga. To ne dokazuje da se određeni broj nikada ne može naručiti.
  • 500: Pogreška: 'Failed loading prefixes': pretraživanje kataloga nije uspjelo. Pokušajte ponovno kasnije i obratite se podršci ako se pogreška nastavi pojavljivati.

Dostupnost i popratni učinci

  • Ovo je korak pregleda ponude, a ne potvrda narudžbe. Dostupnost se može osvježavati dodatnim pretraživanjima kataloga, pa vrijeme odziva može varirati.
  • Cijene se ne vraćaju. Prije slanja narudžbe dohvatite odgovarajuću ponudu za broj ili narudžbu i pregledajte zahtjeve za registraciju.
  • Nemojte tumačiti available kao točan broj raspoloživih brojeva, nulu kao opću zabranu naručivanja ni uspješno pretraživanje kao rezervaciju. Dostupnost se može promijeniti prije naručivanja.