Piirkonna prefiksite loend

Enne alustamist

Valige piirkond, kasutades funktsiooni getareas. Kopeerige piirkonna ID selle vastusest või tagastatud väljalt next_function. USA või Kanada piirkonna puhul kasutage funktsiooni getstates, kui soovite piirata tulemusi ühe osariigi või provintsiga.

Tulemuse tõlgendamine

Kontrollige välja status.code JSON-vastuse sisus ning ka HTTP olekut. Edukad tulemused asuvad massiivis response. Vaikimisi on vastus sorditud nime järgi. available on hinnang ning kataloogi tunnused ei asenda valitud numbri tegelike võimaluste ja registreerimisnõuete kontrollimist.

Järgmise sammu valimine

Kasutage rühmitamata tulemust. Kui välja returns_numbers väärtus on 1, siis tagastatud next_function viitab numbriotsingule. Kui väärtus on 0, määratakse numbrid tellimisel ja tee viitab tellimistoimingule. Enne päringu saatmist tutvuge toimingu ja selle nõuetega: tellimispäring võib tuua kaasa teie kontolt tasu võtmise. Ärge saatke automaatselt päringuid kõigile tagastatud teedele.

Siin hinda ei esitata. Enne ostmist tutvuge asjakohase hinnapakkumise, nõutavate dokumentide ja tellimisjuhistega. Säilitage tagastatud üksiku prefiksi ja hinnapakkumise ID-d, selle asemel et neid kuvatavast telefoniprefiksist ise moodustada.

Täpsemad kuvamisvalikud

compact=1 tagastab juhuslikus järjekorras kuni 100 reast koosneva valimi, mitte suurema tulemikogumi lehekülje. Rühmitamine loob koondread ja sünteetilised ID-d; üksiku prefiksi valimiseks kasutage tavalist rühmitamata vastust. Ärge väitke valimi või rühmitatud tulemuste põhjal, et need kajastavad kogu numbrivalikut või täpseid võimalusi.

Päring

Kasutage HTTPS-i kaudu oma aktiveeritud API-konto autentimisandmeid. Toetatud on Basic autentimine ja API-konto lubatud bearer pääsutõendid; kehtivad kontopiirangud.

Kasutage meetodit GET ja saatke valikulised parameetrid päringustringis. Ärge lootke sellele, et parameetrid loetakse varuvariandina vormiandmetega päringukehast.

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

Vastus

Standardne status/response JSON-ümbris. status.results loendab tagastatud ridu ka valimi või rühmitamise korral. response sisaldab prefiksiobjekte. Hinnavälju ei tagastata. Tavalises rühmitamata vastuses on uuid prefiksi ID; area_uuid ja country_uuid on tagastatud identifikaatorid; prefix ja name on kuvamisandmed; available on saadavuse hinnang, mitte broneering; needs_registration ja restrictions kirjeldavad registreerimisandmeid; sms_coverage, is_mobile ja number_type on kataloogi vihjed, mis ei taga konkreetse numbri mingit võimalust. number_type võib olla tühi või sisaldada muud kataloogi stringiväärtust, seega ärge nõudke kindlat loendväärtuste hulka. state on string ja võib olla tühi või sisaldada kataloogile omast vormindust. latitude ja longitude võivad olla tühjad. metered ja overflow on kataloogi tunnused, mitte rahasummad. returns_numbers valib numbriloendi hankimise tee (1) või numbri tellimisel määramise tee (0). next_function määratleb selle järgmise tee. Rühmitatud vastused sisaldavad lisaks ühendatud omadusi, sealhulgas omaduste varuväärtusi; ärge tõlgendage neid iga numbri kontrollitud võimalustena.

Vastuse struktuuri näide; see ei ole konto reaalajas andmestik ega kehtiv hinnapakkumine.

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

Vead

• 404: Invalid area ID: hankige võimaluste uurimise päringuga kehtiv piirkonna ID.
• 404: State filter is only available for US and CA: teiste riikide puhul jätke parameeter state välja.
• 404: Invalid state: kasutage funktsiooni getstates selle riigi jaoks tagastatud osariiki või provintsi.
• 404: No prefixes found: vastavaid kataloogiridu ei tagastatud. See ei tõenda, et konkreetset numbrit ei saa kunagi tellida.
• 500: Viga: 'Failed loading prefixes': kataloogipäring ebaõnnestus. Proovige hiljem uuesti ja kui viga püsib, võtke ühendust klienditoega.

Saadavus ja kõrvalmõjud

• See on võimaluste uurimise samm, mitte tellimuse kinnitus. Saadavust võidakse värskendada täiendavate kataloogipäringutega, mistõttu vastuse ooteaeg võib varieeruda.
• Hindu ei tagastata. Enne tellimuse esitamist hankige asjakohane numbri või tellimuse hinnapakkumine ja tutvuge registreerimisnõuetega.
• Ärge käsitlege välja available täpse saadaolevate numbrite arvuna, nulli üldise tellimiskeeluna ega edukat päringut broneeringuna. Saadavus võib enne tellimist muutuda.