Lys voorvoegsels vir 'n gebied

Voordat jy begin

Kies 'n gebied met getareas. Kopieer die gebied-ID uit die antwoord of die teruggestuurde next_function. Vir 'n gebied in die VSA of Kanada, gebruik getstates as jy die resultate tot een deelstaat of provinsie wil beperk.

Lees die resultaat

Kontroleer status.code in die JSON-inhoud sowel as die HTTP-status. Suksesvolle resultate is in die response-skikking. Die verstekantwoord word volgens naam gesorteer. available is 'n skatting, en katalogusaanwysers vervang nie die nagaan van die gekose nommer se werklike vermoëns en registrasievereistes nie.

Kies die volgende stap

Gebruik 'n ongegroepeerde resultaat. Wanneer returns_numbers 1 is, wys die teruggestuurde next_function na 'n nommersoektog. Wanneer dit 0 is, word nommers tydens bestelling toegeken en wys die pad na 'n bestelbewerking. Ondersoek die bewerking en die vereistes daarvan voordat jy dit stuur: 'n bestelversoek kan jou rekening met koste belas. Moenie elke teruggestuurde pad outomaties aanroep nie.

Geen prys word hier ingesluit nie. Gaan die toepaslike kwotasie, vereiste dokumente en bestelinstruksies na voordat jy koop. Behou die teruggestuurde ID's vir die individuele voorvoegsel en kwotasie eerder as om hulle uit 'n vertoonde telefoonvoorvoegsel saam te stel.

Gevorderde vertoonopsies

compact=1 stuur 'n steekproef van hoogstens 100 rye in 'n geskommelde volgorde terug, nie 'n bladsy uit 'n groter resultaatstel nie. Groepering skep opsommingsrye en sintetiese ID's; gebruik 'n gewone ongegroepeerde antwoord om 'n individuele voorvoegsel te kies. Moenie steekproefresultate of gegroepeerde resultate gebruik om aanspraak te maak op 'n volledige voorraadlys of presiese vermoëns nie.

Versoek

Gebruik jou geaktiveerde API-rekening se aanmeldbesonderhede oor HTTPS. Basic-verifikasie en geaktiveerde bearer-tokens vir die API-rekening word ondersteun; rekeningbeperkings geld.

Gebruik GET en stuur opsionele parameters in die navraagstring. Moenie daarop staatmaak dat die vorminhoud as terugval gebruik sal word nie.

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

Antwoord

Die standaard-JSON-omhulsel vir status/response. status.results tel die teruggestuurde rye, ook wanneer steekproefneming of groepering gebruik word. response bevat voorvoegselobjekte. Geen prysvelde word teruggestuur nie. In die gewone ongegroepeerde antwoord is uuid die voorvoegsel-ID; area_uuid en country_uuid is teruggestuurde identifiseerders; prefix en name is vertooninligting; available is 'n skatting van beskikbaarheid eerder as 'n bespreking; needs_registration en restrictions beskryf registrasie-inligting; sms_coverage, is_mobile en number_type is katalogusaanduidings, nie 'n waarborg van 'n bepaalde vermoë van 'n nommer nie. number_type kan leeg wees of 'n ander katalogusstring bevat; moenie dus 'n vaste enumerasie vereis nie. state is 'n string en kan leeg wees of katalogusformatering bevat. latitude en longitude kan leeg wees. metered en overflow is katalogusaanwysers, nie geldbedrae nie. returns_numbers kies 'n roete wat nommers lys (1) of 'n roete wat nommers tydens bestelling toeken (0). next_function identifiseer daardie volgende roete. Gegroepeerde antwoorde bevat ook saamgevoegde kenmerke, insluitend terugvalwaardes vir kenmerke; moenie dit as geverifieerde vermoëns van elke nommer vertolk nie.

Illustrasie van die antwoordstruktuur; nie lewendige rekeningdata of 'n huidige kwotasie nie.

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

Foute

• 404: Invalid area ID: verkry 'n huidige gebied-ID deur verkenning.
• 404: State filter is only available for US and CA: laat state weg vir ander lande.
• 404: Invalid state: gebruik 'n deelstaat/provinsie wat deur getstates vir hierdie land teruggestuur word.
• 404: No prefixes found: geen ooreenstemmende katalogusrye is teruggestuur nie. Dit bewys nie dat 'n bepaalde nommer nooit bestel kan word nie.
• 500: Fout: 'Failed loading prefixes': die katalogusopsoeking het misluk. Probeer later weer en kontak ondersteuning as die probleem voortduur.

Beskikbaarheid en newe-effekte

• Dit is 'n verkenningstap, nie 'n bestelbevestiging nie. Beskikbaarheid kan deur verdere katalogusopsoekings bygewerk word, dus kan die antwoordtyd wissel.
• Pryse word nie teruggestuur nie. Kry die toepaslike nommer- of bestelkwotasie en gaan die registrasievereistes na voordat jy 'n bestelling plaas.
• Moenie available as 'n presiese voorraadtelling, nul as 'n algemene verbod op bestellings, of 'n suksesvolle opsoeking as 'n bespreking beskou nie. Beskikbaarheid kan verander voordat jy bestel.