Ontwikkelaars

GET/v3/inventory/{number}

Overzicht van aangekochte nummers opvragen

Lees de configuratie en opgeslagen status van aangekochte nummers, eventueel gefilterd op telefoonnummer.

Op deze pagina
  1. Verzoek
  2. Antwoord
  3. Filteren en paginering
  4. Geen overeenkomende nummers
  5. Volgende stappen

Vraag de records van aangekochte nummers op waarvan de opgeslagen eigenaar overeenkomt met het account dat bij uw API-inloggegevens hoort. De aanwezigheid van een record staat los van een geslaagde test met een daadwerkelijke oproep.

Verzoek

Gebruik API-inloggegevens aan de serverzijde via HTTPS. De voorbeelden lezen inloggegevens uit omgevingsvariabelen; ze bevatten geen werkende inloggegevens. Controleer status.code in de JSON-inhoud en controleer ook de HTTP-status. Deze verouderde handlers stellen bij een applicatiefout niet consequent een HTTP-foutstatus in.

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

Gebruik de optionele padvariant om op één opgeslagen telefoonnummer te filteren:

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

Gebruik het opgeslagen internationale telefoonnummer als cijferreeks, inclusief landcode. Geef in plaats daarvan geen PBX-toestelnummer, UUID van een nummer, gebieds-ID of prefix-ID op. Het opgegeven nummer selecteert een bestaand record; hiermee wordt geen nummer aangekocht of geconfigureerd.

Antwoord

Het veld response is bij succes altijd een array, ook bij de padvariant voor één nummer. status.results is de lengte van de array.

Dit is een voorbeeld van de antwoordstructuur, geen accountgegevens of actuele prijsopgave.

{
  "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"
      }
    }
  ]
}
Geretourneerde nummervelden
VeldBetekenis
number, uuid, description, isocodeHet opgeslagen telefoonnummer, de nummeridentificatie zonder afleidbare betekenis, de beschrijving en de landcode.
configOpgeslagen velden voor spraakbestemmingen, externe doorschakeling, de sms-bestemming en sms-doorsturing. Dit eindpunt wijzigt deze niet.
featuresOpgeslagen indicatoren voor ondersteuning van spraak, sms en mms. Opgeslagen indicatoren uit het verouderde systeem zijn niet gegarandeerd booleaanse JSON-waarden.
status.capacityWaarden voor toegewezen en gebruikte kanalen, de overloopinstelling en het opgeslagen tarief voor overschrijding. Dit zijn opgeslagen metagegevens, geen nieuwe capaciteitsopgave of test met een daadwerkelijke oproep.
status.originationOpgeslagen metagegevens over de oproepherkomst. Behandel identificaties als waarden zonder afleidbare betekenis; leid geen applicatielogica af uit interne namen.
status.service_active, force_codec, force_dtmfOpgeslagen velden voor activering en mediaconfiguratie. Een indicator op zichzelf bewijst niet dat inkomend verkeer succesvol wordt afgeleverd.
billingOpgeslagen waarden voor CNAM, overloop, verlenging, persistentie en aanmaak. Het uitlezen ervan wijzigt de verlengingsinstellingen of andere factureringsinstellingen niet.
priceOpgeslagen aansluitkosten, maandprijzen, tarieven per minuut en minutentegoeden. De handler levert geen valutaveld of nieuwe prijsopgave. Leid de valuta niet af uit de voorbeeldwaarden en gebruik deze niet als actuele aankoopofferte.

Filteren en paginering

Deze handler heeft geen paginering, limiet voor de paginagrootte of expliciete sorteervolgorde. Hij retourneert alle niet-ongeldig verklaarde records die door zijn query worden geselecteerd. Hij biedt geen filter voor uitsluitend nummers met een actieve dienst en geen afzonderlijke weergave van gearchiveerde nummers. Ga er niet van uit dat de volgorde van de geretourneerde records stabiel is.

Geen overeenkomende nummers

Als het account geen overeenkomende, niet-ongeldig verklaarde records heeft, bevat de JSON-inhoud status.code 404 en een bericht met daarin no numbers found. Er wordt geen lege array als succesvol resultaat geretourneerd. Het bericht bevat een achtervoegsel met een bronverwijzing dat clients niet als een stabiele identificatie mogen interpreteren.

Volgende stappen

Gebruik numberinfo als u voor één nummer de aanvullende registratie- en nummerreferentievelden uit het verouderde systeem nodig hebt. Controleer de bestemmingen voor spraak en berichten voordat u een route wijzigt via een afzonderlijke configuratiebewerking.