Listoni prefikset për një zonë

Para se të filloni

Zgjidhni një zonë duke përdorur getareas. Kopjoni ID-në e zonës nga përgjigjja e tij ose nga fusha e kthyer next_function. Për një zonë në US ose në Kanada, përdorni getstates nëse dëshironi t'i kufizoni rezultatet në një shtet ose provincë.

Lexoni rezultatin

Kontrolloni status.code në trupin JSON, si edhe statusin HTTP. Rezultatet e suksesshme gjenden në vargun response. Përgjigjja e parazgjedhur renditet sipas emrit. available është një vlerësim dhe treguesit e katalogut nuk zëvendësojnë kontrollin e aftësive reale dhe të kërkesave të regjistrimit për numrin e zgjedhur.

Zgjidhni hapin e radhës

Përdorni një rezultat të pagrupuar. Kur returns_numbers është 1, fusha e kthyer next_function drejton te një kërkim numrash. Kur vlera është 0, numrat caktohen në momentin e porositjes dhe shtegu drejton te një veprim porositjeje. Shqyrtoni veprimin dhe kërkesat e tij përpara se ta dërgoni: një kërkesë porositjeje mund të shkaktojë një tarifim në llogarinë tuaj. Mos dërgoni automatikisht kërkesa për çdo shteg të kthyer.

Këtu nuk përfshihet asnjë çmim. Shqyrtoni ofertën përkatëse të çmimit, dokumentet e kërkuara dhe udhëzimet e porositjes përpara blerjes. Ruani ID-të e kthyera të prefiksit individual dhe të ofertës së çmimit, në vend që t'i ndërtoni nga një prefiks telefonik i shfaqur.

Opsione të avancuara të shfaqjes

compact=1 kthen një mostër me renditje të rastësishme me jo më shumë se 100 rreshta, jo një faqe nga një bashkësi më e madhe rezultatesh. Grupimi krijon rreshta përmbledhës dhe ID sintetike; përdorni një përgjigje të zakonshme të pagrupuar për të zgjedhur një prefiks individual. Mos përdorni rezultate të marra si mostër ose të grupuara për të pretenduar se inventari është shterues ose se aftësitë janë të sakta.

Kërkesa

Përdorni kredencialet e llogarisë suaj të aktivizuar API përmes HTTPS. Mbështeten autentikimi Basic dhe tokenët bearer të aktivizuar për llogarinë API; zbatohen kufizimet e llogarisë.

Përdorni GET dhe dërgoni parametrat opsionalë në vargun e pyetjes. Mos u mbështetni te përdorimi alternativ i trupit të formularit.

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

Përgjigjja

Struktura standarde mbështjellëse JSON me status/response. status.results numëron rreshtat e kthyer, edhe kur merret një mostër ose bëhet grupim. response përmban objekte prefiksesh. Nuk kthehen fusha çmimesh. Në përgjigjen e zakonshme të pagrupuar, uuid është ID-ja e prefiksit; area_uuid dhe country_uuid janë identifikues të kthyer; prefix dhe name janë të dhëna për shfaqje; available është një vlerësim i disponueshmërisë dhe jo një rezervim; needs_registration dhe restrictions përshkruajnë informacionin e regjistrimit; sms_coverage, is_mobile dhe number_type janë tregues orientues të katalogut, jo garanci për një aftësi të caktuar të numrit. number_type mund të jetë bosh ose një varg tjetër i katalogut, prandaj mos kërkoni një bashkësi fikse vlerash të numëruara. state është një varg dhe mund të jetë bosh ose të përmbajë formatim të katalogut. latitude dhe longitude mund të jenë bosh. metered dhe overflow janë tregues të katalogut, jo shuma monetare. returns_numbers zgjedh një rrugë për listimin e numrave (1) ose një rrugë për caktimin e numrave në momentin e porositjes (0). next_function identifikon atë rrugë të radhës. Përgjigjet e grupuara përmbajnë gjithashtu veçori të bashkuara, përfshirë vlera zëvendësuese të veçorive; mos i interpretoni këto si aftësi të verifikuara të çdo numri.

Strukturë ilustruese e përgjigjes; nuk përfaqëson të dhëna të drejtpërdrejta të llogarisë apo një ofertë aktuale çmimi.

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

Gabimet

• 404: Invalid area ID: merrni një ID aktuale të zonës nga hapat e kërkimit në katalog.
• 404: State filter is only available for US and CA: mos e përfshini state për vendet e tjera.
• 404: Invalid state: përdorni një shtet/provincë të kthyer nga getstates për këtë vend.
• 404: No prefixes found: nuk u kthye asnjë rresht përkatës i katalogut. Kjo nuk provon se një numër i caktuar nuk mund të porositet kurrë.
• 500: Gabim: 'Failed loading prefixes': kërkimi në katalog dështoi. Provoni përsëri më vonë dhe kontaktoni mbështetjen nëse problemi vazhdon.

Disponueshmëria dhe efektet anësore

• Ky është një hap kërkimi në katalog, jo një konfirmim porosie. Disponueshmëria mund të përditësohet përmes kërkimeve të mëtejshme në katalog, prandaj koha e përgjigjes mund të ndryshojë.
• Çmimet nuk kthehen. Merrni ofertën përkatëse të çmimit për numrin ose porosinë dhe shqyrtoni kërkesat e regjistrimit përpara se të bëni një porosi.
• Mos e trajtoni available si një numërim të saktë të stokut, zeron si një ndalim universal të porositjes apo një kërkim të suksesshëm si rezervim. Disponueshmëria mund të ndryshojë përpara porositjes.