Finn tilgjengelige telefonnumre

Velg et enkeltprefiks

Bruk kallene for å finne land og dekningsområder, og deretter getprefixes uten gruppering. Kopier det valgte prefiksets uuid. Hvis returns_numbers er 0, tildeler prefikset et nummer ved bestilling; bruk den returnerte next_function i stedet for å kreve en liste over enkeltnumre.

Bla gjennom et avgrenset resultatsett

For et vanlig søk bruker du compact=1 og angir ønsket størrelse på resultatsettet både i stien og i spørringsparameteren quantity, som vist nedenfor. Det finnes ingen side- eller markørparameter. Et kompakt resultat er et utvalg; å gjenta en forespørsel garanterer ikke at neste side er uten overlapp. Ikke tolk et tomt eller lite resultat som det totale antallet tilgjengelige numre.

Finn et siffermønster som er lett å huske

Angi number_filter_mode=contains eller ends_with sammen med number_filter_value. Verdien må inneholde 1–15 sifre. Et søk kan hente avgrensede sett med kandidater før filteret brukes, og kan derfor overse andre tilgjengelige numre som samsvarer. Hvis du trenger en kilde som støtter det påkrevde søket, skaffer du en pid-selektor fra MultiTEL og bruker filter_required=1; et manglende eller ikke støttet valg gir en API-feil.

Se gjennom det valgte nummeret

Les number, info.uuid, den valgte price[].uuid, navnene på tilgjengelige funksjoner og registreringskravene fra samme resultat. price-arrayet kan tilby flere planer med ulike kanalantall og satser. Beløpsfelt og antall kan være kodet som strenger. Valgfrie metadata, inkludert info.state, varierer mellom kilder; ikke krev én universell struktur for delstatsopplysninger eller utled priser fra en ID.

I behandlingsforløpet uten strømming fjernes dupliserte kandidater, og kandidatene fordeles på tvers av kildene før det valgte resultatsettet sorteres etter den første planens månedspris. Andre behandlingsforløp kan begynne å strømme tidligere, så det finnes ingen garanti for samlet sortering eller fjerning av duplikater som gjelder alle forespørsler. Sortering beviser heller ikke at det returnerte utvalget inneholder det billigste nummeret i hele katalogen.

Bestill separat og bekreft resultatet

Et søk verken kjøper eller reserverer noe. Ta vare på identifikatorene for det returnerte nummeret og planen til bestillingsprosessen under samme konto. Se gjennom den faktiske planen, kravene og kostnadene før du sender inn en bestilling. Registreringskrav kan forsinke aktivering; et søkeresultat fastsetter ingen bestemt aktiveringsfrist.

Forespørsel

Bruk en aktivert MultiTEL API-konto: HTTP Basic-påloggingsopplysninger for en passordkonto, eller Authorization: Bearer med en tokenkonto. Kontoens tillatelser og IP-begrensninger gjelder. Se den felles veiledningen for autentisering.

Stiparametere og URL-spørringsparametere. Bruk GET for den offentlige søkeprosessen. Behandlingskoden godtar også enkelte skjema- og forespørselsverdier, men dette er ikke et søke-API med JSON i forespørselskroppen.

curl --fail-with-body --get \
  --user "${MULTITEL_API_USERNAME}:${MULTITEL_API_PASSWORD}" \
  --data-urlencode "compact=1" \
  --data-urlencode "quantity=10" \
  "https://api.multitel.net/v3/getnumbers/${PREFIX_ID}/10"

Stiparametere
Navn	Type	Påkrevd	Beskrivelse
`prefix_id`	string	Ja	En enkeltprefiks-ID returnert i et ugruppert getprefixes-svar. Kopier den nøyaktig; ikke erstatt den med en ID for et land, dekningsområde, gruppert prefiks eller en prisplan.
`quantity`	integer	Nei	Mål for antall som skal hentes, standardverdi 1. Verdier som ikke er positive, blir 1. quantity i stien alene gir ingen pålitelig grense for det samlede resultatet: et søk som ikke er låst til en kilde og mangler spørringsparameteren quantity, kan utvide innhentingen og returnere opptil 50 oppføringer per kilde før videre behandling. For vanlig gjennomgang av avgrensede resultatsett bruker du compact=1 og gjentar ønsket antall i spørringen, som i eksemplet.

Spørringsparametere
Navn	Type	Påkrevd	Beskrivelse
`quantity`	integer	Nei	Ønsket størrelse på det endelige resultatsettet. Verdier som ikke er tomme, konverteres til heltall med en minsteverdi på 1. I behandlingsforløpet uten strømming som ikke er låst til en kilde, begrenser dette den endelige fordelingen. Det tvinger ikke tjenesten til å finne så mange numre. Kompakte søk som er låst til en kilde, kan returnere kildens kompakte resultatsett i stedet for å følge denne grensen.
`compact`	string	Nei	Bruk 1, true eller on for et mindre svar uten strømming, med opptil 10 oppføringer per kilde før den endelige fordelingen. Resultatene er et utvalg av numrene som er hentet inn nå, ikke en fullstendig katalog.
`number_filter_mode`	string	Nei	Valgfri modus for siffermønster: contains eller ends_with. Angi også number_filter_value. Resultatene kontrolleres mot normaliserte sifre i telefonnumrene; søket går ikke gjennom alle tilgjengelige numre for å garantere at alle mulige treff blir funnet.
`number_filter_value`	string	Nei	Mellom 1 og 15 sifre, uten mellomrom, + eller tegnsetting. Innledende nuller har betydning; send verdien som tekst.
`filter_required`	string	Nei	Avansert: 1, true, yes eller on krever en eksplisitt valgt nummerkilde som støtter filtermodusen. Ellers returnerer API-et status.code 422. Dette er ikke nødvendig for vanlig gjennomgang av katalogen.
`pid`	string	Nei	Avansert selektor for tilgjengelige numre, levert av MultiTEL. Numeriske former og støttede heksadesimale former på 32 tegn godtas; ukjente verdier ignoreres uten varsel. Utelat denne ved vanlig bruk. Ikke utled selektorer fra pris-ID-er eller anta at en vilkårlig selektor avgrenser de tilgjengelige numrene utelukkende til den valgte kilden.

Svar

Ett JSON-objekt som inneholder status og response. Ved suksess er status.code 200, og response er et array med nummeroppføringer. status.results er antallet oppføringer i det returnerte arrayet; status.msg kan være Results: N eller OK for et strømmet svar. Uten compact=1 skriver enkelte søk response-arrayet trinnvis og avslutter med status, så vent til hele JSON-kroppen er mottatt. Dette er ikke linjeskiftavgrenset JSON. Kontroller status.code selv når HTTP-overføringen lykkes. Typiske felt vises nedenfor; kildespesifikke metadata og valgfrie felt varierer. Behandle alle identifikatorer som ugjennomsiktige verdier, og oppbevar nummeret sammen med den valgte price[].uuid.

Illustrasjon av svarstrukturen; verken faktiske kontodata eller et gjeldende pristilbud.

{
  "status": {
    "code": 200,
    "msg": "Results: 1",
    "results": 1
  },
  "response": [
    {
      "number": "12125550123",
      "info": {
        "uuid": "NUMBER_ID_FROM_RESPONSE",
        "prefix_uuid": "PREFIX_ID_FROM_RESPONSE",
        "area_uuid": "AREA_ID_FROM_RESPONSE",
        "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
        "country_iso": "US",
        "prefix": "+1212",
        "name": "Example area",
        "state": "US"
      },
      "price": [
        {
          "uuid": "PRICE_PLAN_ID_FROM_RESPONSE",
          "per_minute": "0.01",
          "per_sms": "0",
          "per_mms": "0",
          "free_minutes": "0",
          "setup_price": "1.00",
          "monthly_price": "2.00",
          "yearly_price": "0",
          "channels": "2"
        }
      ],
      "contract": {
        "term": "1 month",
        "renewal": "monthly",
        "notice": "none"
      },
      "restrictions": {
        "needs_registration": "0",
        "restrictions": ""
      },
      "features": [
        "voice"
      ],
      "overflow": "0"
    }
  ]
}

Feil

401: Autentisering mislyktes. Ugyldige eller manglende påloggingsopplysninger og avvist tilgang til API-kontoen gir ingen søkeresultater.
404: Invalid prefix ID, Invalid country, Invalid area eller No numbers found. Les status.msg; et feilsvar er ikke et array med numre.
400: NUMBER_FILTER_INVALID i response.code: ugyldig modus, en verdi som ikke består av 1–15 sifre, eller filter_required uten at både modus og verdi er angitt.
422: NUMBER_FILTER_UNSUPPORTED i response.code: enten tildeler prefikset et nummer ved bestilling (reason=order_only_prefix og next_function identifiserer bestillingsruten), eller den eksplisitt valgte kilden kan ikke støtte det påkrevde filteret.

Tilgjengelighet og sideeffekter

Denne behandlingskoden søker og klargjør pristilbud; den sender ikke inn en nummerbestilling og belaster ingen kostnad for kjøp av nummer. Den kan oppdatere katalogens hurtigbuffere, fjerne utdaterte hurtigbufrede nummeroppføringer, lagre kontospesifikke prisplaner og skrive søkelogger.
Tilgjengeligheten er et øyeblikksbilde, ikke en reservasjon. En etterfølgende bestilling kan mislykkes eller vise en annen tilgjengelighet. Avstem bestillingsresultatet før du forsøker kjøpet på nytt.
Prisene er kontospesifikke. Behold den valgte plan-ID-en for samme konto, og se gjennom bestillingsvilkårene og kostnadene separat; dette endepunktet alene beviser ikke at en pris vil være gyldig frem til en senere bestilling.
Nummeret og prisene i eksemplet er oppdiktede eksempler på svarstrukturen, ikke et gjeldende pristilbud. Funksjoner, kanalantall, avtaleperiode og registreringsopplysninger må leses fra det faktiske valgte resultatet.
Enkelte registreringsbeskrivelser inneholder formatert tekst eller lenker. Behandle returnerte strenger som ikke-klarerte data når du viser dem i din egen applikasjon.
Tilgjengelighet av mobilnumre og tilhørende flagg avhenger av hvilke numre kontoen har rett til å bruke, og hvilke numre som er tilgjengelige. Et katalogprefiks eller et is_mobile-flagg alene fastslår ikke hvilke mobilfunksjoner et bestemt nummer har.