Utvecklare

GET/v3/inventory/{number}

Lista köpta telefonnummer

Läs konfiguration och lagrad status för köpta telefonnummer, med möjlighet att filtrera efter telefonnummer.

På denna sida
  1. Begäran
  2. Svar
  3. Filtrering och sidindelning
  4. Inga matchande nummer
  5. Nästa steg

Lista poster för köpta telefonnummer vars lagrade ägare motsvarar det konto som dina API-inloggningsuppgifter representerar. Att en post finns är inte detsamma som att ett test med ett verkligt samtal har lyckats.

Begäran

Använd API-inloggningsuppgifter på serversidan via HTTPS. Exemplen läser inloggningsuppgifter från miljövariabler och innehåller inga fungerande inloggningsuppgifter. Kontrollera status.code i JSON-kroppen samt HTTP-statusen. Dessa äldre hanterare anger inte konsekvent en HTTP-felstatus när ett applikationsfel inträffar.

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

Använd den valfria sökvägsformen för att filtrera efter ett enskilt lagrat telefonnummer:

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

Ange det lagrade internationella telefonnumret med enbart siffror, inklusive landskod. Ange inte en PBX-anknytning, ett nummers UUID, ett områdes-ID eller ett prefix-ID i stället. Det angivna numret väljer en befintlig post; det köper eller konfigurerar inte något nummer.

Svar

Medlemmen response är alltid en array när begäran lyckas, även när sökvägsformen för ett enskilt nummer används. status.results är arrayens längd.

Detta illustrerar svarets struktur och är varken kontouppgifter eller en aktuell prisoffert.

{
  "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"
      }
    }
  ]
}
Returnerade nummerfält
FältBetydelse
number, uuid, description, isocodeDet lagrade telefonnumret, en nummeridentifierare vars innehåll inte ska tolkas, beskrivningen och landskoden.
configLagrade fält för samtalsdestinationer, extern vidarekoppling, SMS-destination och vidarebefordran av SMS. Den här ändpunkten ändrar dem inte.
featuresLagrade flaggor för stöd för röstsamtal, SMS och MMS. Äldre lagrade flaggor är inte garanterat booleska JSON-värden.
status.capacityVärden för tilldelade och använda kanaler, inställning för överflöde och lagrad avgift för överanvändning. Detta är lagrade metadata, inte en ny kapacitetsoffert eller ett test med ett verkligt samtal.
status.originationLagrade metadata om samtalsursprung. Behandla identifierare som värden vars innehåll inte ska tolkas; härled inte applikationslogik från interna namn.
status.service_active, force_codec, force_dtmfLagrade fält för aktivering och mediekonfiguration. En flagga i sig bevisar inte att inkommande trafik levereras korrekt.
billingLagrade värden för CNAM, överflöde, förnyelse, beständighet och skapande. Att läsa dem ändrar inte förnyelse eller andra faktureringsinställningar.
priceLagrade startavgifter, månadspriser, minutpriser och minutpotter. Hanteraren tillhandahåller varken något valutafält eller någon ny offert. Dra inga slutsatser om valutan utifrån exempelvärdena och använd dem inte som en aktuell inköpsoffert.

Filtrering och sidindelning

Den här hanteraren har ingen sidindelning, ingen gräns för sidstorlek och ingen uttrycklig sorteringsordning. Den returnerar alla poster som inte har annullerats och som väljs av dess databasfråga. Den har inget filter för enbart aktiva tjänster och ingen separat vy för arkiverade nummer. Utgå inte från att ordningen på de returnerade posterna är stabil.

Inga matchande nummer

Om kontot inte har några matchande poster som inte har annullerats innehåller JSON-kroppen status.code 404 och ett meddelande som innehåller no numbers found. Svaret är inte en tom array som anger att begäran lyckades. Meddelandet innehåller ett suffix med en källreferens som klienter inte bör tolka som en stabil identifierare.

Nästa steg

Använd numberinfo när du behöver de ytterligare äldre fälten för registrering och nummerreferens för ett enskilt nummer. Kontrollera destinationerna för samtal och meddelanden innan du ändrar någon routning genom en separat konfigurationsåtgärd.