Listarea inventarului de numere achiziționate

Listați înregistrările numerelor achiziționate al căror proprietar stocat corespunde contului reprezentat de datele dvs. de autentificare API. Prezența unei înregistrări este distinctă de un test reușit cu un apel real.

Cerere

Utilizați datele de autentificare API pe partea de server, prin HTTPS. Exemplele citesc datele de autentificare din variabile de mediu; nu conțin date de autentificare funcționale. Verificați status.code în corpul JSON, precum și codul de stare HTTP. Aceste rutine de procesare vechi nu setează în mod consecvent un cod de stare HTTP de eroare pentru o eroare a aplicației.

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

Pentru a filtra după un singur număr de telefon stocat, utilizați forma opțională a căii:

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

Utilizați numărul de telefon internațional stocat, exprimat în cifre, inclusiv codul de țară. Nu transmiteți în locul acestuia o extensie PBX, un UUID de număr, un ID de zonă sau un ID de prefix. Numărul furnizat selectează o înregistrare existentă; nu achiziționează și nu configurează un număr.

Răspuns

Membrul response este întotdeauna un tablou în caz de succes, inclusiv pentru forma căii cu un singur număr. status.results reprezintă lungimea tabloului.

Aceasta este o structură de răspuns prezentată cu titlu de exemplu, nu date ale contului sau o ofertă de preț actuală.

{
  "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"
      }
    }
  ]
}

Câmpurile returnate pentru număr
Câmp	Semnificație
`number, uuid, description, isocode`	Numărul de telefon stocat, identificatorul opac al numărului, descrierea și codul de țară.
`config`	Câmpurile stocate pentru destinațiile apelurilor vocale, redirecționarea externă, destinația SMS și redirecționarea SMS. Acest punct de acces nu le modifică.
`features`	Indicatorii stocați ai capabilităților pentru apeluri vocale, SMS și MMS. Nu se garantează că indicatorii stocați în formatul vechi sunt valori booleene JSON.
`status.capacity`	Valorile pentru canalele alocate și utilizate, setarea de depășire a capacității și tariful stocat pentru depășire. Acestea sunt metadate stocate, nu o ofertă actualizată pentru capacitate sau un test cu un apel real.
`status.origination`	Metadatele stocate privind originea apelurilor. Tratați identificatorii ca valori opace; nu deduceți logica aplicației din denumirile interne.
`status.service_active, force_codec, force_dtmf`	Câmpurile stocate pentru activare și configurarea fluxurilor media. Un indicator singur nu dovedește că apelurile primite sunt livrate cu succes.
`billing`	Valorile stocate pentru CNAM, depășirea capacității, reînnoire, persistență și creare. Citirea lor nu modifică reînnoirea sau alte setări de facturare.
`price`	Prețurile stocate pentru activare, abonamentul lunar și utilizarea pe minut, precum și alocările de minute. Rutina de procesare nu furnizează niciun câmp pentru monedă și nicio ofertă actualizată. Nu deduceți moneda din valorile exemplificate și nu le utilizați ca ofertă actuală de achiziție.

Filtrare și paginare

Această rutină de procesare nu are paginare, limită pentru dimensiunea paginii sau ordine explicită de sortare. Returnează toate înregistrările neanulate selectate de interogarea sa. Nu implementează un filtru care să includă doar numerele cu serviciul activ și nici o vizualizare separată pentru numerele arhivate. Nu presupuneți că ordinea înregistrărilor returnate este stabilă.

Niciun număr corespunzător

Dacă în cont nu există înregistrări neanulate care să corespundă criteriilor, corpul JSON conține status.code 404 și un mesaj care conține no numbers found. Nu returnează un tablou gol cu rezultat de succes. Mesajul include un sufix de referință la sursă pe care aplicațiile client nu ar trebui să îl interpreteze ca pe un identificator stabil.

Pașii următori

Utilizați numberinfo atunci când aveți nevoie de câmpurile suplimentare din formatul vechi privind înregistrarea și referința numărului, pentru un singur număr. Verificați destinațiile apelurilor vocale și ale mesajelor înainte de a modifica orice rută printr-o operațiune separată de configurare.