Programeri

GET/v3/inventory/{number}

Prikaz popisa kupljenih brojeva

Dohvatite konfiguraciju i pohranjeni status kupljenih brojeva, uz mogućnost filtriranja prema telefonskom broju.

Na ovoj stranici
  1. Zahtjev
  2. Odgovor
  3. Filtriranje i podjela na stranice
  4. Nema odgovarajućih brojeva
  5. Sljedeći koraci

Prikažite zapise o kupljenim brojevima čiji pohranjeni vlasnik odgovara računu kojem pripadaju vaše vjerodajnice za API. Prisutnost zapisa nije isto što i uspješan test stvarnog poziva.

Zahtjev

Upotrebljavajte vjerodajnice za API na poslužiteljskoj strani putem HTTPS-a. Primjeri čitaju vjerodajnice iz varijabli okruženja; ne sadrže vjerodajnice koje se mogu upotrijebiti za pristup. Provjerite status.code u tijelu JSON odgovora, kao i HTTP status. Ovi naslijeđeni obrađivači ne postavljaju dosljedno HTTP status pogreške kada dođe do pogreške u aplikaciji.

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

Za filtriranje prema jednom pohranjenom telefonskom broju upotrijebite neobavezni oblik putanje:

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

Upotrijebite pohranjeni međunarodni telefonski broj zapisan znamenkama, uključujući pozivni broj države. Nemojte umjesto njega proslijediti interni broj PBX-a, UUID broja, identifikator područja ili identifikator prefiksa. Navedeni broj odabire postojeći zapis; time se broj ne kupuje niti konfigurira.

Odgovor

Član response uvijek je polje kada je zahtjev uspješan, uključujući oblik putanje za jedan broj. status.results označava duljinu polja.

Ovo je ilustrativni prikaz strukture odgovora, a ne podaci računa ni aktualna ponuda cijena.

{
  "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"
      }
    }
  ]
}
Vraćena polja broja
PoljeZnačenje
number, uuid, description, isocodePohranjeni telefonski broj, identifikator broja bez značenja koje bi trebalo tumačiti, opis i oznaka države.
configPohranjena polja za odredišta glasovnih poziva, vanjsko prosljeđivanje, odredište SMS poruka i prosljeđivanje SMS poruka. Ova krajnja točka ne mijenja ta polja.
featuresPohranjene oznake podrške za glasovne pozive, SMS i MMS. Nije zajamčeno da su naslijeđene pohranjene oznake logičke vrijednosti u JSON-u.
status.capacityVrijednosti dodijeljenih i korištenih kanala, postavka prekoračenja kapaciteta i pohranjena naknada za prekoračenje. To su pohranjeni metapodaci, a ne nova ponuda kapaciteta ni test stvarnog poziva.
status.originationPohranjeni metapodaci o izvorištu poziva. Identifikatore tretirajte kao vrijednosti čije značenje ne treba tumačiti; nemojte izvoditi logiku aplikacije iz internih naziva.
status.service_active, force_codec, force_dtmfPohranjena polja aktivacije i konfiguracije medija. Sama oznaka ne dokazuje uspješnu isporuku dolaznih poziva.
billingPohranjene vrijednosti za CNAM, prekoračenje kapaciteta, obnovu, trajnost i stvaranje. Njihovim čitanjem ne mijenjaju se obnova ni druge postavke naplate.
pricePohranjene cijene uspostave, mjesečne cijene i cijene po minuti te uključene količine minuta. Obrađivač ne pruža polje valute ni novu ponudu cijena. Nemojte zaključivati o valuti na temelju oglednih vrijednosti niti ih upotrebljavati kao aktualnu ponudu za kupnju.

Filtriranje i podjela na stranice

Ovaj obrađivač nema podjelu na stranice, ograničenje veličine stranice ni izričito zadan redoslijed sortiranja. Vraća sve zapise koji nisu poništeni, a koje njegov upit odabere. Ne omogućuje filtriranje samo brojeva s aktivnom uslugom ni zaseban prikaz arhiviranih brojeva. Nemojte pretpostavljati da je redoslijed vraćenih zapisa stalan.

Nema odgovarajućih brojeva

Ako račun nema odgovarajućih zapisa koji nisu poništeni, tijelo JSON odgovora sadrži status.code 404 i poruku koja sadrži no numbers found. Ne vraća prazno polje uz status uspjeha. Poruka uključuje sufiks s referencom na izvor koji klijenti ne bi trebali parsirati kao stalan identifikator.

Sljedeći koraci

Upotrijebite numberinfo kada su vam za jedan broj potrebna dodatna naslijeđena polja registracije i referenci broja. Provjerite odredišta glasovnih poziva i poruka prije nego što promijenite bilo koju rutu zasebnom operacijom konfiguracije.