Izstrādātājiem

GET/v3/inventory/{number}

Iegādāto numuru saraksta iegūšana

Nolasiet iegādāto numuru konfigurāciju un saglabāto statusu, pēc izvēles filtrējot pēc tālruņa numura.

Šajā lapā
  1. Pieprasījums
  2. Atbilde
  3. Filtrēšana un dalīšana lapās
  4. Nav atbilstošu numuru
  5. Nākamās darbības

Iegūstiet to iegādāto numuru ierakstu sarakstu, kuru saglabātais īpašnieks atbilst kontam, ko identificē jūsu API piekļuves dati. Ieraksta esamība nenozīmē, ka ir sekmīgi veikts reāla zvana tests.

Pieprasījums

Izmantojiet API piekļuves datus servera pusē, sazinoties ar HTTPS starpniecību. Piemēros piekļuves dati tiek nolasīti no vides mainīgajiem; piemēros nav derīgu piekļuves datu. Pārbaudiet status.code JSON atbildes pamattekstā, kā arī HTTP statusu. Šie mantotie apstrādātāji lietojumprogrammas kļūdas gadījumā ne vienmēr iestata HTTP kļūdas statusu.

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

Lai filtrētu pēc viena saglabāta tālruņa numura, pēc izvēles izmantojiet šo ceļa formu:

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

Norādiet saglabāto starptautisko tālruņa numuru ar cipariem, iekļaujot valsts kodu. Tā vietā nenorādiet PBX iekšējo numuru, numura UUID, apgabala ID vai prefiksa ID. Norādītais numurs atlasa esošu ierakstu; tas neiegādājas un nekonfigurē numuru.

Atbilde

Lauks response veiksmīgas atbildes gadījumā vienmēr ir masīvs, arī tad, ja izmantota ceļa forma vienam numuram. status.results ir masīva garums.

Šis ir ilustratīvs atbildes struktūras piemērs, nevis konta dati vai aktuāls cenas piedāvājums.

{
  "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"
      }
    }
  ]
}
Atgrieztie numura lauki
LauksNozīme
number, uuid, description, isocodeSaglabātais tālruņa numurs, numura identifikators, kura iekšējā struktūra nav interpretējama, apraksts un valsts kods.
configSaglabātie balss zvanu galamērķu, ārējās pāradresācijas, SMS galamērķa un SMS pāradresācijas lauki. Šis galapunkts tos nemaina.
featuresSaglabātie balss zvanu, SMS un MMS iespēju karodziņi. Nav garantēts, ka mantotie saglabātie karodziņi ir JSON loģiskās vērtības.
status.capacityPiešķirto un izmantoto kanālu vērtības, pārplūdes iestatījums un saglabātā maksa par limita pārsniegšanu. Tie ir saglabāti metadati, nevis aktuāls kapacitātes piedāvājums vai reāla zvana tests.
status.originationSaglabātie zvanu izcelsmes metadati. Neinterpretējiet identifikatoru iekšējo struktūru; neveidojiet lietojumprogrammas loģiku, pamatojoties uz iekšējiem nosaukumiem.
status.service_active, force_codec, force_dtmfSaglabātie aktivizācijas un multivides konfigurācijas lauki. Karodziņš pats par sevi neapliecina sekmīgu ienākošo sakaru piegādi.
billingSaglabātās CNAM, pārplūdes, atjaunošanas, pastāvīguma un izveides vērtības. To nolasīšana nemaina atjaunošanas vai citus norēķinu iestatījumus.
priceSaglabātās pieslēgšanas, mēneša un minūtes cenas un piešķirtie minūšu apjomi. Apstrādātājs nenodrošina valūtas lauku vai aktuālu cenas piedāvājumu. Neizdariet secinājumus par valūtu pēc piemēra vērtībām un neizmantojiet tās kā aktuālu iegādes cenas piedāvājumu.

Filtrēšana un dalīšana lapās

Šim apstrādātājam nav dalīšanas lapās, lapas lieluma ierobežojuma vai skaidri noteiktas kārtošanas secības. Tas atgriež visus ar tā vaicājumu atlasītos ierakstus, kas nav anulēti. Tas nenodrošina filtru tikai ierakstiem ar aktīvu pakalpojumu vai atsevišķu arhivēto numuru skatu. Nepieņemiet, ka atgriezto ierakstu secība ir nemainīga.

Nav atbilstošu numuru

Ja kontam nav atbilstošu neanulētu ierakstu, JSON atbildes pamattekstā lauka status.code vērtība ir 404, un tajā ir ziņojums, kas satur no numbers found. Tukšs masīvs ar veiksmīgas atbildes statusu netiek atgriezts. Ziņojumā ir iekļauts sufikss ar atsauci uz avotu, kuru klientiem nevajadzētu parsēt kā nemainīgu identifikatoru.

Nākamās darbības

Izmantojiet numberinfo, ja vienam numuram nepieciešami papildu mantotie reģistrācijas un numura atsauces lauki. Pirms jebkura maršruta maiņas ar atsevišķu konfigurācijas darbību pārbaudiet balss zvanu un ziņojumu galamērķus.