Sviluppatori

GET/v3/inventory/{number}

Elencare i numeri acquistati

Consultare la configurazione e lo stato memorizzato dei numeri acquistati, con filtro facoltativo per numero di telefono.

Su questa pagina
  1. Richiesta
  2. Risposta
  3. Filtri e paginazione
  4. Nessun numero corrispondente
  5. Passaggi successivi

Elenca i record dei numeri acquistati il cui proprietario memorizzato corrisponde all'account rappresentato dalle tue credenziali API. La presenza di un record è cosa distinta dall'esito positivo di una prova con una chiamata reale.

Richiesta

Usa le credenziali API lato server tramite HTTPS. Gli esempi leggono le credenziali dalle variabili d'ambiente; non contengono credenziali funzionanti. Controlla status.code nel corpo JSON oltre allo stato HTTP. Questi gestori legacy non impostano sistematicamente uno stato di errore HTTP in caso di errore applicativo.

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

Per filtrare in base a un singolo numero di telefono memorizzato, usa la forma facoltativa del percorso:

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

Usa il numero di telefono internazionale memorizzato espresso in cifre, incluso il prefisso internazionale. Non passare al suo posto un interno PBX, un UUID del numero, un ID di area o un ID di prefisso. Il numero fornito seleziona un record esistente; non acquista né configura alcun numero.

Risposta

Il campo response è sempre un array in caso di esito positivo, anche nella forma del percorso per un singolo numero. status.results è la lunghezza dell'array.

Questa struttura di risposta è un esempio illustrativo, non contiene dati dell'account né un preventivo aggiornato.

{
  "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"
      }
    }
  ]
}
Campi dei numeri restituiti
CampoSignificato
number, uuid, description, isocodeIl numero di telefono memorizzato, l'identificatore opaco del numero, la descrizione e il codice del paese.
configCampi memorizzati relativi alle destinazioni vocali, all'inoltro esterno, alla destinazione SMS e all'inoltro SMS. Questo endpoint non li modifica.
featuresIndicatori memorizzati delle funzionalità voce, SMS e MMS. Non è garantito che gli indicatori legacy memorizzati siano valori booleani JSON.
status.capacityValori dei canali assegnati e utilizzati, impostazione di overflow e addebito memorizzato per il superamento dei limiti. Si tratta di metadati memorizzati, non di un preventivo aggiornato sulla capacità né di una prova con una chiamata reale.
status.originationMetadati di originazione memorizzati. Tratta gli identificatori come opachi; non ricavare la logica applicativa dai nomi interni.
status.service_active, force_codec, force_dtmfCampi memorizzati relativi all'attivazione e alla configurazione dei media. Un indicatore da solo non dimostra che l'inoltro delle chiamate in entrata avvenga correttamente.
billingValori memorizzati relativi a CNAM, overflow, rinnovo, persistenza e creazione. La loro lettura non modifica il rinnovo né altre impostazioni di fatturazione.
pricePrezzi memorizzati di attivazione, mensili e al minuto, e quantità di minuti inclusi. Il gestore non fornisce alcun campo relativo alla valuta né un preventivo aggiornato. Non dedurre la valuta dai valori di esempio e non usarli come preventivo attuale per un acquisto.

Filtri e paginazione

Questo gestore non prevede paginazione, limiti alle dimensioni delle pagine né un ordinamento esplicito. Restituisce tutti i record non annullati selezionati dalla sua query. Non implementa un filtro per i soli numeri con servizio attivo né una vista separata dei numeri archiviati. Non presumere che l'ordine dei record restituiti sia stabile.

Nessun numero corrispondente

Se l'account non ha record non annullati corrispondenti, il corpo JSON contiene status.code 404 e un messaggio contenente no numbers found. Non viene restituito un array vuoto con esito positivo. Il messaggio include un suffisso di riferimento al codice sorgente che i client non devono interpretare come un identificatore stabile.

Passaggi successivi

Usa numberinfo quando ti servono i campi legacy aggiuntivi di registrazione e di riferimento al numero per un singolo numero. Controlla le destinazioni vocali e di messaggistica prima di modificare qualsiasi instradamento mediante un'operazione di configurazione separata.