Udviklere

GET/v3/inventory/{number}

Vis oversigten over købte telefonnumre

Læs konfigurationen og den gemte status for købte telefonnumre, eventuelt filtreret efter telefonnummer.

På denne side
  1. Anmodning
  2. Svar
  3. Filtrering og sideinddeling
  4. Ingen matchende numre
  5. Næste trin

Vis posterne for købte telefonnumre, hvis gemte ejer svarer til den konto, som dine API-legitimationsoplysninger repræsenterer. At en post findes, er ikke det samme som en vellykket test med et faktisk opkald.

Anmodning

Brug API-legitimationsoplysninger på serversiden over HTTPS. Eksemplerne læser legitimationsoplysninger fra miljøvariabler; de indeholder ingen gyldige legitimationsoplysninger. Kontrollér status.code i JSON-svarindholdet samt HTTP-statussen. Disse ældre handlere angiver ikke konsekvent en HTTP-fejlstatus ved en applikationsfejl.

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

Brug den valgfrie stivariant til at filtrere efter et enkelt gemt telefonnummer:

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

Angiv det gemte internationale telefonnummer som cifre inklusive landekode. Angiv ikke et PBX-lokalnummer, et nummers UUID, et område-id eller et præfiks-id i stedet. Det angivne nummer vælger en eksisterende post; det medfører hverken køb eller konfiguration af et nummer.

Svar

Feltet response er altid et array, når anmodningen lykkes, også ved stivarianten med et enkelt nummer. status.results er arrayets længde.

Dette illustrerer svarets struktur og er hverken kontodata eller et aktuelt 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"
      }
    }
  ]
}
Returnerede nummerfelter
FeltBetydning
number, uuid, description, isocodeDet gemte telefonnummer, nummerets identifikator uden fortolkelig betydning, beskrivelse og landekode.
configGemte felter for destinationer til taleopkald, ekstern viderestilling, SMS-destination og SMS-videresendelse. Dette endepunkt ændrer dem ikke.
featuresGemte flag for understøttelse af taleopkald, SMS og MMS. De ældre gemte flag er ikke nødvendigvis booleske JSON-værdier.
status.capacityVærdier for tildelte og anvendte kanaler, overløbsindstilling og gemt gebyr for overforbrug. Dette er gemte metadata, ikke et nyt kapacitetstilbud eller en test med et faktisk opkald.
status.originationGemte metadata om opkaldets oprindelse. Behandl identifikatorer som værdier uden fortolkelig betydning; udled ikke applikationslogik af interne navne.
status.service_active, force_codec, force_dtmfGemte felter for aktivering og mediekonfiguration. Et flag alene beviser ikke, at indgående trafik leveres korrekt.
billingGemte værdier for CNAM, overløb, fornyelse, persistens og oprettelse. Læsning af dem ændrer hverken fornyelse eller andre faktureringsindstillinger.
priceGemte oprettelsespriser, månedspriser, minutpriser og minutkvoter. Handleren leverer hverken et valutafelt eller et nyt tilbud. Udled ikke valutaen af eksempelværdierne, og brug dem ikke som et aktuelt købstilbud.

Filtrering og sideinddeling

Denne handler har hverken sideinddeling, en grænse for sidestørrelse eller en udtrykkeligt angivet sorteringsrækkefølge. Den returnerer alle ikke-annullerede poster, som dens forespørgsel udvælger. Den implementerer hverken et filter, der kun medtager numre med aktiv tjeneste, eller en separat visning af arkiverede numre. Antag ikke, at de returnerede posters rækkefølge er stabil.

Ingen matchende numre

Hvis kontoen ikke har nogen matchende ikke-annullerede poster, indeholder JSON-svarindholdet status.code 404 og en meddelelse, der indeholder no numbers found. Der returneres ikke et tomt array som et vellykket svar. Meddelelsen indeholder et suffiks med en kildereference, som klienter ikke bør fortolke som en stabil identifikator.

Næste trin

Brug numberinfo når du har brug for de yderligere ældre registrerings- og nummerreferencefelter for ét nummer. Kontrollér destinationerne for taleopkald og beskeder, før du ændrer nogen rute via en separat konfigurationshandling.