Zhvilluesit

GET/v3/inventory/{number}

Listoni inventarin e numrave të blerë

Lexoni konfigurimin dhe gjendjen e ruajtur të numrave të blerë, me mundësi filtrimi sipas numrit të telefonit.

Në këtë faqe
  1. Kërkesa
  2. Përgjigjja
  3. Filtrimi dhe ndarja në faqe
  4. Asnjë numër që përputhet
  5. Hapat e mëtejshëm

Listoni regjistrimet e numrave të blerë, pronari i ruajtur i të cilëve përputhet me llogarinë që përfaqësojnë kredencialet tuaja të API-së. Prania e një regjistrimi nuk është e njëjtë me një test të suksesshëm me një telefonatë reale.

Kërkesa

Përdorni kredenciale të API-së në anën e serverit përmes HTTPS. Shembujt i lexojnë kredencialet nga ndryshoret e mjedisit; ata nuk përmbajnë kredenciale funksionale. Kontrolloni status.code në trupin JSON, si edhe statusin HTTP. Këta përpunues të trashëguar nuk vendosin gjithmonë një status gabimi HTTP kur ndodh një gabim në aplikacion.

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

Për të filtruar sipas një numri të vetëm telefoni të ruajtur, përdorni formën opsionale të shtegut:

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

Përdorni numrin ndërkombëtar të telefonit të ruajtur në formë shifrash, duke përfshirë kodin e shtetit. Mos jepni në vend të tij një numër të brendshëm PBX, një UUID të numrit, një identifikues zone ose një identifikues prefiksi. Numri i dhënë zgjedh një regjistrim ekzistues; ai nuk blen dhe as nuk konfiguron një numër.

Përgjigjja

Anëtari response është gjithmonë një varg kur kërkesa përfundon me sukses, përfshirë formën e shtegut për një numër të vetëm. status.results është gjatësia e vargut.

Kjo është një strukturë ilustruese e përgjigjes, jo të dhëna të llogarisë apo një ofertë aktuale çmimi.

{
  "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"
      }
    }
  ]
}
Fushat e numrit të kthyera në përgjigje
FushaKuptimi
number, uuid, description, isocodeNumri i telefonit i ruajtur, identifikuesi i numrit pa kuptim të brendshëm për klientin, përshkrimi dhe kodi i shtetit.
configFushat e ruajtura për destinacionet e thirrjeve zanore, përcjelljen e jashtme, destinacionin e SMS-ve dhe përcjelljen e SMS-ve. Kjo pikë fundore nuk i ndryshon ato.
featuresTreguesit e ruajtur të mbështetjes për thirrje zanore, SMS dhe MMS. Nuk garantohet që treguesit e ruajtur të trashëguar të jenë vlera logjike JSON.
status.capacityVlerat e kanaleve të caktuara dhe të përdorura, cilësimi për tejkalimin e kapacitetit dhe tarifa e ruajtur për tejkalimin. Këto janë të dhëna përshkruese të ruajtura, jo një ofertë e re për kapacitetin apo një test me një telefonatë reale.
status.originationTë dhënat përshkruese të ruajtura për origjinimin e thirrjeve. Trajtojini identifikuesit si vlera pa kuptim të brendshëm për klientin; mos nxirrni logjikën e aplikacionit nga emrat e brendshëm.
status.service_active, force_codec, force_dtmfFushat e ruajtura të aktivizimit dhe të konfigurimit të medias. Një tregues i vetëm nuk dëshmon që thirrjet hyrëse mbërrijnë me sukses.
billingVlerat e ruajtura të CNAM-it, tejkalimit të kapacitetit, rinovimit, ruajtjes së vazhdueshme dhe krijimit. Leximi i tyre nuk ndryshon rinovimin apo cilësime të tjera të faturimit.
priceÇmimet e ruajtura të aktivizimit, çmimet mujore dhe për minutë, si edhe sasitë e minutave të përfshira. Përpunuesi nuk jep as fushë për monedhën, as ofertë të re çmimi. Mos e nxirrni monedhën nga vlerat e shembullit dhe mos i përdorni ato si ofertë aktuale blerjeje.

Filtrimi dhe ndarja në faqe

Ky përpunues nuk ka ndarje në faqe, kufi për madhësinë e faqes apo renditje të përcaktuar shprehimisht. Ai kthen të gjitha regjistrimet e paanuluara që zgjedh kërkimi i tij. Ai nuk ofron filtër vetëm për numrat me shërbim aktiv dhe as një pamje të veçantë për numrat e arkivuar. Mos supozoni se rendi i regjistrimeve të kthyera mbetet i njëjtë.

Asnjë numër që përputhet

Nëse llogaria nuk ka regjistrime të paanuluara që përputhen, trupi JSON ka status.code 404 dhe një mesazh që përmban no numbers found. Ai nuk kthen një varg bosh që tregon sukses. Mesazhi përfshin një prapashtesë me referencë ndaj burimit, të cilën klientët nuk duhet ta analizojnë si një identifikues të qëndrueshëm.

Hapat e mëtejshëm

Përdorni numberinfo kur ju nevojiten fushat shtesë të trashëguara të regjistrimit dhe të referencës së numrit për një numër të vetëm. Kontrolloni destinacionet e thirrjeve zanore dhe të mesazheve përpara se të ndryshoni ndonjë rrugë përmes një veprimi të veçantë konfigurimi.