Utviklere

GET/v3/inventory/{number}

List opp kjøpte telefonnumre

Les konfigurasjon og lagret status for kjøpte telefonnumre, eventuelt filtrert etter telefonnummer.

På denne siden
  1. Forespørsel
  2. Svar
  3. Filtrering og sideinndeling
  4. Ingen samsvarende numre
  5. Neste trinn

List opp oppføringene for kjøpte telefonnumre der den lagrede eieren samsvarer med kontoen som API-legitimasjonen din representerer. At en oppføring finnes, er ikke det samme som at en test med en faktisk samtale har vært vellykket.

Forespørsel

Bruk API-legitimasjon på serversiden over HTTPS. Eksemplene leser legitimasjon fra miljøvariabler; de inneholder ingen fungerende legitimasjon. Kontroller status.code i JSON-innholdet i tillegg til HTTP-statusen. Disse eldre behandlerne angir ikke konsekvent en HTTP-feilstatus ved en applikasjonsfeil.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory"

For å filtrere etter ett lagret telefonnummer bruker du den valgfrie stivarianten:

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory/12025550100"

Oppgi det lagrede internasjonale telefonnummeret som sifre, inkludert landskode. Ikke oppgi et internnummer i en telefonsentral, en UUID for et telefonnummer, en område-ID eller en prefiks-ID i stedet. Det oppgitte nummeret velger en eksisterende oppføring; det kjøper eller konfigurerer ikke et telefonnummer.

Svar

Feltet response er alltid en matrise ved vellykket resultat, også med stivarianten for ett enkelt nummer. status.results er lengden på matrisen.

Dette illustrerer svarstrukturen og er verken kontodata eller et gjeldende pristilbud.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550100",
      "uuid": "NUMBER_UUID",
      "description": "Main reception",
      "isocode": "US",
      "config": {
        "uri": "sip:reception@example.com",
        "uri2": "",
        "uri3": "",
        "forward_destination": "",
        "sms_uri": "",
        "sms_forward_destination": ""
      },
      "features": {
        "voice": "1",
        "sms": "1",
        "mms": "0"
      },
      "status": {
        "capacity": {
          "assigned_channels": "2",
          "used_channels": "0",
          "overflow": "0",
          "overage_charge": "0.01"
        },
        "origination": {
          "origination_trunk_id": "ORIGINATION_ID",
          "origination_trunk_name": "ORIGINATION_NAME",
          "origination_country_iso": "US",
          "origination_continent_iso": "NA",
          "origination_continent_name": "North America"
        },
        "service_active": "1",
        "force_codec": "",
        "force_dtmf": ""
      },
      "billing": {
        "cnam": "0",
        "overflow": "0",
        "autorenew": "1",
        "persistent": "0",
        "date_created": "2026-01-01 00:00:00"
      },
      "price": {
        "setup_price": "0.00",
        "monthly_price": "1.00",
        "per_minute": "0.01",
        "free_minutes": "0",
        "remaining_minutes": "0"
      }
    }
  ]
}
Returnerte felt for telefonnumre
FeltBetydning
number, uuid, description, isocodeDet lagrede telefonnummeret, en ugjennomsiktig identifikator for nummeret, beskrivelse og landskode.
configLagrede felt for taledestinasjoner, ekstern viderekobling, SMS-destinasjon og videresending av SMS. Dette endepunktet endrer dem ikke.
featuresLagrede flagg for støtte for tale, SMS og MMS. Det er ingen garanti for at eldre lagrede flagg er boolske JSON-verdier.
status.capacityVerdier for tildelte og brukte kanaler, innstilling for overløp og lagret gebyr for overforbruk. Dette er lagrede metadata, ikke et nytt kapasitetstilbud eller en test med en faktisk samtale.
status.originationLagrede metadata om samtaleopprinnelse. Behandle identifikatorer som ugjennomsiktige; ikke utled applikasjonslogikk fra interne navn.
status.service_active, force_codec, force_dtmfLagrede felt for aktivering og mediekonfigurasjon. Et flagg alene beviser ikke at innkommende trafikk leveres som den skal.
billingLagrede verdier for CNAM, overløp, fornyelse, persistens og opprettelse. Lesing av disse endrer ikke fornyelse eller andre faktureringsinnstillinger.
priceLagrede etableringspriser, månedspriser, minuttpriser og inkluderte minutter. Behandleren oppgir verken et valutafelt eller et nytt pristilbud. Ikke utled valutaen fra eksempelverdiene eller bruk dem som et gjeldende kjøpstilbud.

Filtrering og sideinndeling

Denne behandleren har ingen sideinndeling, grense for sidestørrelse eller uttrykkelig sorteringsrekkefølge. Den returnerer alle oppføringer som ikke er annullert, og som velges av spørringen. Den har verken et filter som bare viser numre med aktiv tjeneste, eller en egen visning for arkiverte numre. Ikke anta at rekkefølgen på de returnerte oppføringene er stabil.

Ingen samsvarende numre

Hvis kontoen ikke har noen samsvarende oppføringer som ikke er annullert, inneholder JSON-innholdet status.code 404 og en melding som inneholder no numbers found. Det returneres ikke en tom matrise med vellykket status. Meldingen inneholder et suffiks med en kildereferanse som klienter ikke bør tolke som en stabil identifikator.

Neste trinn

Bruk numberinfo når du trenger de ekstra eldre feltene for registrering og nummerreferanse for ett nummer. Kontroller destinasjonene for tale og meldinger før du endrer en rute gjennom en separat konfigurasjonsoperasjon.