List opp prefikser for et område

Før du begynner

Velg et område ved hjelp av getareas. Kopier område-ID-en fra svaret eller fra den returnerte next_function. For et område i USA eller Canada bruker du getstates hvis du vil begrense resultatene til én delstat eller provins.

Les resultatet

Kontroller status.code i JSON-kroppen i tillegg til HTTP-statusen. Resultater fra vellykkede forespørsler ligger i response-matrisen. Som standard er svaret sortert etter navn. available er et anslag, og katalogflagg erstatter ikke kontroll av det valgte nummerets faktiske funksjonalitet og registreringskrav.

Velg neste trinn

Bruk et ugruppert resultat. Når returns_numbers er 1, peker den returnerte next_function på et nummersøk. Når verdien er 0, tildeles numrene ved bestilling, og stien peker på en bestillingsoperasjon. Undersøk operasjonen og kravene til den før du sender forespørselen: en bestillingsforespørsel kan belaste kontoen din. Ikke send forespørsler automatisk til alle returnerte stier.

Ingen pris er inkludert her. Gå gjennom det relevante pristilbudet, påkrevde dokumenter og bestillingsinstruksjonene før du kjøper. Ta vare på de returnerte ID-ene for det enkelte prefikset og pristilbudet i stedet for å konstruere dem ut fra et vist telefonprefiks.

Avanserte visningsalternativer

compact=1 returnerer et utvalg i tilfeldig rekkefølge med høyst 100 rader, ikke en side fra et større resultatsett. Gruppering oppretter oppsummeringsrader og syntetiske ID-er; bruk et vanlig, ugruppert svar for å velge et enkelt prefiks. Ikke bruk utvalg eller grupperte resultater som grunnlag for påstander om en uttømmende beholdningsoversikt eller nøyaktig funksjonalitet.

Forespørsel

Bruk påloggingsinformasjonen for den aktiverte API-kontoen din over HTTPS. Autentisering med Basic og aktiverte bearer-tokener for API-kontoer støttes; kontobegrensninger gjelder.

Bruk GET og send valgfrie parametere i spørringsstrengen. Ikke baser deg på at skjemadata i forespørselskroppen brukes som reserveløsning.

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

Stiparametere
Navn	Type	Påkrevd	Beskrivelse
`area_id`	string	Ja	Kopier områdeidentifikatoren fra getareas eller den tilhørende next_function. Behandle den som en ugjennomsiktig verdi; ikke konstruer eller hash den selv.

Spørringsparametere
Navn	Type	Påkrevd	Beskrivelse
`state`	string	Nei	Gjelder bare områder i US og CA. Bruk en delstats- eller provinskode fra getstates, eller det fulle navnet på delstaten eller provinsen. For koder skilles det ikke mellom store og små bokstaver; for navn ignoreres også gjentatte blanktegn. Et annet land eller en ukjent verdi som ikke er tom, gir en API-feil.
`compact`	string	Nei	Valgfri utvalgsmodus: 1, true eller on. Resultatene vises i tilfeldig rekkefølge, med høyst 100 rader. Utelat denne parameteren for å få en fullstendig resultatliste; dette endepunktet har ingen side- eller markørbasert paginering.
`group`	integer	Nei	Avanserte visningsoppsummeringer: verdiene 1 til 6 slår sammen rader og returnerer maskerte prefikser for visning. Gruppe-UUID-er er syntetiske og kan ikke brukes om hverandre med ID-ene til enkelte prefikser. Send en ugruppert forespørsel før du velger et prefiks for nummersøk eller bestilling. Utelat denne parameteren i den vanlige arbeidsflyten.
`pid`	string	Nei	Valgfri beholdningsvelger levert av MultiTEL, i numerisk form eller en støttet heksadesimal form med 32 tegn. Utelat den ved vanlig bruk. Ukjente verdier ignoreres uten varsel. Verdien er ikke et telefonprefiks eller en prisplan-ID.

Svar

Standard JSON-omslutning med status/response. status.results teller de returnerte radene, også ved bruk av utvalg eller gruppering. response inneholder prefiksobjekter. Ingen prisfelter returneres. I det vanlige, ugrupperte svaret er uuid prefiks-ID-en; area_uuid og country_uuid er returnerte identifikatorer; prefix og name er visningsinformasjon; available er et anslag for tilgjengelighet, ikke en reservasjon; needs_registration og restrictions beskriver registreringsinformasjon; sms_coverage, is_mobile og number_type er indikasjoner fra katalogen, ikke en garanti for en bestemt funksjonalitet for et nummer. number_type kan være tom eller inneholde en annen katalogstreng, så ikke krev et fast sett med opplistede verdier. state er en streng og kan være tom eller inneholde formatering fra katalogen. latitude og longitude kan være tomme. metered og overflow er katalogflagg, ikke pengebeløp. returns_numbers velger en rute for nummerlisting (1) eller en rute for tildeling ved bestilling (0). next_function identifiserer denne neste ruten. Grupperte svar inneholder i tillegg sammenslåtte egenskaper, inkludert reserveverdier for egenskaper; ikke tolk disse som bekreftet funksjonalitet for hvert enkelt nummer.

Eksempel på svarstruktur; dette er ikke løpende kontodata eller et gjeldende 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"
    }
  ]
}

Feil

404: Invalid area ID: hent en gjeldende område-ID fra katalogoppslagene.
404: State filter is only available for US and CA: utelat state for andre land.
404: Invalid state: bruk en delstat eller provins som returneres av getstates for dette landet.
404: No prefixes found: ingen samsvarende katalograder ble returnert. Dette beviser ikke at et bestemt nummer aldri kan bestilles.
500: Feil: 'Failed loading prefixes': katalogoppslaget mislyktes. Prøv igjen senere, og kontakt kundestøtte hvis problemet vedvarer.

Tilgjengelighet og sideeffekter

Dette er et trinn for å finne tilgjengelige alternativer, ikke en bestillingsbekreftelse. Tilgjengeligheten kan oppdateres ved hjelp av flere katalogoppslag, så svartiden kan variere.
Priser returneres ikke. Hent det aktuelle pristilbudet for nummeret eller bestillingen, og gå gjennom registreringskravene før du legger inn en bestilling.
Ikke tolk available som en nøyaktig lagerbeholdning, null som et generelt forbud mot bestilling eller et vellykket oppslag som en reservasjon. Tilgjengeligheten kan endre seg før bestilling.