Luettele alueen numeroprefiksit

Ennen aloittamista

Valitse alue toiminnolla getareas. Kopioi alueen tunniste sen vastauksesta tai palautetusta next_function-kentästä. Jos alue on Yhdysvalloissa tai Kanadassa, käytä toimintoa getstates, jos haluat rajata tulokset yhteen osavaltioon tai provinssiin.

Tuloksen tulkitseminen

Tarkista status.code JSON-rungosta sekä HTTP-tilakoodi. Onnistuneen pyynnön tulokset ovat taulukossa response. Oletusarvoisesti vastaus on lajiteltu nimen mukaan. available on arvio, eivätkä luettelon tunnisteet korvaa valitun numeron todellisten ominaisuuksien ja rekisteröintivaatimusten tarkistamista.

Valitse seuraava vaihe

Käytä ryhmittelemätöntä tulosta. Kun returns_numbers on 1, palautettu next_function viittaa numerohakuun. Kun arvo on 0, numerot osoitetaan tilauksen yhteydessä ja polku viittaa tilaustoimintoon. Tarkista toiminto ja sen vaatimukset ennen pyynnön lähettämistä: tilauspyyntö voi aiheuttaa veloituksen tilillesi. Älä lähetä pyyntöjä automaattisesti kaikkiin palautettuihin polkuihin.

Tässä ei palauteta hintaa. Tarkista asiaankuuluva hintatarjous, vaaditut asiakirjat ja tilausohjeet ennen ostamista. Säilytä palautetut yksittäisen numeroprefiksin ja hintatarjouksen tunnisteet sen sijaan, että muodostaisit ne näytettävästä puhelinnumeron alkuosasta.

Näyttöasetukset edistyneeseen käyttöön

compact=1 palauttaa satunnaiseen järjestykseen sekoitetun, enintään 100 rivin otoksen, ei suuremman tulosjoukon sivua. Ryhmittely luo yhteenvetorivejä ja keinotekoisia tunnisteita; valitse yksittäinen numeroprefiksi tavallisesta ryhmittelemättömästä vastauksesta. Älä esitä otokseen tai ryhmittelyyn perustuvien tulosten kattavan koko numerovalikoimaa tai kuvaavan ominaisuuksia täsmällisesti.

Pyyntö

Käytä käyttöön otetun API-tilisi tunnuksia HTTPS-yhteydellä. Tuettuja ovat Basic-todennus ja käyttöön otetut API-tilin bearer-tunnisteet; tilin rajoitukset ovat voimassa.

Käytä GET-menetelmää ja lähetä valinnaiset parametrit kyselymerkkijonossa. Älä luota siihen, että parametrit luettaisiin varamenettelynä lomakemuotoisesta pyyntörungosta.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Vastaus

Tavanomainen JSON-vastausrakenne, jossa ovat status/response. status.results ilmoittaa palautettujen rivien määrän myös otosta tai ryhmittelyä käytettäessä. response sisältää numeroprefiksioliot. Hintakenttiä ei palauteta. Tavallisessa ryhmittelemättömässä vastauksessa uuid on numeroprefiksin tunniste; area_uuid ja country_uuid ovat palautettuja tunnisteita; prefix ja name ovat näyttötietoja; available on saatavuusarvio, ei varaus; needs_registration ja restrictions kuvaavat rekisteröintitietoja; sms_coverage, is_mobile ja number_type ovat luettelon suuntaa antavia tietoja, eivät takuu yksittäisen numeron ominaisuuksista. number_type voi olla tyhjä tai jokin muu luettelon merkkijono, joten älä edellytä arvojen kuulumista kiinteään lueteltuun arvojoukkoon. state on merkkijono, joka voi olla tyhjä tai sisältää luettelon mukaista muotoilua. latitude ja longitude voivat olla tyhjiä. metered ja overflow ovat luettelon tunnisteita, eivät rahamääriä. returns_numbers valitsee joko numeroluetteloon johtavan reitin (1) tai reitin, jolla numero osoitetaan tilauksen yhteydessä (0). next_function yksilöi tämän seuraavan reitin. Ryhmitellyt vastaukset sisältävät lisäksi yhdistettyjä ominaisuuksia, mukaan lukien ominaisuuksien vara-arvot; älä tulkitse näitä jokaisen numeron varmennetuiksi ominaisuuksiksi.

Havainnollistava vastauksen rakenne; ei tilin reaaliaikaisia tietoja eikä voimassa oleva hintatarjous.

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

Virheet

• 404: Invalid area ID: hae ajantasainen alueen tunniste hakutoiminnoilla.
• 404: State filter is only available for US and CA: jätä state-parametri pois muiden maiden kohdalla.
• 404: Invalid state: käytä toiminnon getstates tälle maalle palauttamaa osavaltiota tai provinssia.
• 404: No prefixes found: vastaavia luettelorivejä ei palautettu. Tämä ei todista, ettei tiettyä numeroa voisi koskaan tilata.
• 500: Virhe: 'Failed loading prefixes': haku luettelosta epäonnistui. Yritä myöhemmin uudelleen ja ota yhteyttä tukeen, jos ongelma jatkuu.

Saatavuus ja sivuvaikutukset

• Tämä on hakuvaihe, ei tilausvahvistus. Saatavuustietoja voidaan päivittää luetteloon tehtävillä lisähauilla, joten vastausviive voi vaihdella.
• Hintoja ei palauteta. Hae kyseistä numeroa tai tilausta koskeva hintatarjous ja tarkista rekisteröintivaatimukset ennen tilauksen tekemistä.
• Älä tulkitse available-arvoa täsmälliseksi saatavilla olevien numeroiden määräksi, nollaa yleispäteväksi tilauskielloksi tai onnistunutta hakua varaukseksi. Saatavuus voi muuttua ennen tilaamista.