Vis præfikser for et område

Før du går i gang

Vælg et område ved hjælp af getareas. Kopiér områdets ID fra svaret eller den returnerede next_function. For et område i USA eller Canada bruges getstates hvis du vil begrænse resultaterne til én delstat eller provins.

Læs resultatet

Kontrollér status.code i JSON-indholdet samt HTTP-statussen. Resultater fra vellykkede kald findes i response som et array. Som standard er svaret sorteret efter navn. available er et estimat, og katalogflag erstatter ikke en kontrol af det valgte nummers faktiske funktioner og registreringskrav.

Vælg næste trin

Brug et ugrupperet resultat. Når returns_numbers er 1, peger den returnerede next_function på en nummersøgning. Når værdien er 0, tildeles numre ved bestillingen, og stien peger på en bestillingsoperation. Undersøg operationen og dens krav, før du sender anmodningen: En bestillingsanmodning kan medføre en debitering af din konto. Send ikke automatisk anmodninger til alle returnerede stier.

Der er ingen pris inkluderet her. Gennemgå det relevante pristilbud, de påkrævede dokumenter og bestillingsvejledningen før køb. Bevar de returnerede ID'er for det enkelte præfiks og pristilbuddet i stedet for at konstruere dem ud fra et vist telefonpræfiks.

Avancerede visningsindstillinger

compact=1 returnerer en stikprøve på højst 100 rækker i blandet rækkefølge, ikke en side fra et større resultatsæt. Gruppering opretter oversigtsrækker og syntetiske ID'er; brug et almindeligt ugrupperet svar til at vælge et enkelt præfiks. Brug ikke stikprøver eller grupperede resultater som grundlag for påstande om den samlede nummerbeholdning eller præcise funktioner.

Anmodning

Brug legitimationsoplysningerne til din aktiverede API-konto over HTTPS. Basic-autentificering og aktiverede bearer-tokens til API-kontoen understøttes; kontoens begrænsninger gælder.

Brug GET, og send valgfrie parametre i forespørgselsstrengen. Forlad dig ikke på, at formularindhold i anmodningens body bruges som alternativ.

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

Svar

Den sædvanlige JSON-indpakning med status/response. status.results tæller de returnerede rækker, også ved stikprøver eller gruppering. response indeholder præfiksobjekter. Der returneres ingen prisfelter. I det almindelige ugrupperede svar er uuid præfiksets ID; area_uuid og country_uuid er returnerede identifikatorer; prefix og name er oplysninger til visning; available er et estimat af tilgængeligheden og ikke en reservation; needs_registration og restrictions beskriver registreringsoplysninger; sms_coverage, is_mobile og number_type er vejledende katalogoplysninger, ikke en garanti for en bestemt funktion på et nummer. number_type kan være tom eller indeholde en anden katalogstreng, så stil ikke krav om et fast sæt enum-værdier. state er en streng og kan være tom eller indeholde katalogets formatering. latitude og longitude kan være tomme. metered og overflow er katalogflag, ikke pengebeløb. returns_numbers vælger en rute til at vise en nummerliste (1) eller en rute til tildeling ved bestilling (0). next_function identificerer denne næste rute. Grupperede svar indeholder desuden sammenlagte funktioner, herunder funktionsværdier, der bruges som reserve; fortolk ikke disse som verificerede funktioner for hvert enkelt nummer.

Illustration af svarstrukturen; hverken aktuelle kontodata eller et aktuelt pristilbud.

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

Fejl

• 404: Invalid area ID: Hent et aktuelt område-ID via et opslag.
• 404: State filter is only available for US and CA: Udelad state for andre lande.
• 404: Invalid state: Brug en delstat eller provins, der returneres af getstates for dette land.
• 404: No prefixes found: Der blev ikke returneret nogen matchende katalogrækker. Det beviser ikke, at et bestemt nummer aldrig kan bestilles.
• 500: Fejl: 'Failed loading prefixes': Opslaget i kataloget mislykkedes. Prøv igen senere, og kontakt support, hvis fejlen fortsætter.

Tilgængelighed og sideeffekter

• Dette er et opslagstrin, ikke en ordrebekræftelse. Tilgængeligheden kan blive opdateret ved hjælp af yderligere katalogopslag, så svartiden kan variere.
• Der returneres ingen priser. Hent det relevante pristilbud for nummeret eller bestillingen, og gennemgå registreringskravene, før du afgiver en bestilling.
• Betragt ikke available som en præcis lagerbeholdning, nul som et generelt forbud mod bestilling eller et vellykket opslag som en reservation. Tilgængeligheden kan ændre sig inden bestillingen.