Įsigytų numerių sąrašo gavimas

Gaukite įsigytų numerių įrašų, kurių išsaugotas savininkas atitinka jūsų API prisijungimo duomenimis nurodomą paskyrą, sąrašą. Įrašo buvimas nėra sėkmingo tikro skambučio bandymo patvirtinimas.

Užklausa

Naudokite serverio pusėje saugomus API prisijungimo duomenis ir HTTPS. Pavyzdžiuose prisijungimo duomenys nuskaitomi iš aplinkos kintamųjų; veikiančių prisijungimo duomenų juose nėra. Patikrinkite status.code JSON turinyje ir HTTP būseną. Šios senosios apdorojimo programos ne visada nustato HTTP klaidos būseną, kai įvyksta programos klaida.

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

Norėdami filtruoti pagal vieną išsaugotą telefono numerį, naudokite pasirenkamą kelio formą:

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

Pateikite išsaugotą tarptautinį telefono numerį skaitmenimis, įskaitant šalies kodą. Vietoj jo nepateikite PBX vidinio numerio, numerio UUID, vietovės ID ar prefikso ID. Pateiktas numeris parenka esamą įrašą; juo numeris neįsigyjamas ir nekonfigūruojamas.

Atsakymas

Laukas response sėkmės atveju visada yra masyvas, taip pat ir naudojant kelio formą su vienu numeriu. status.results nurodo masyvo ilgį.

Tai atsakymo struktūros pavyzdys, o ne paskyros duomenys ar dabartinės kainos pasiūlymas.

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

Grąžinami numerio laukai
Laukas	Reikšmė
`number, uuid, description, isocode`	Išsaugotas telefono numeris, numerio identifikatorius, kurio vidinės struktūros nereikia interpretuoti, aprašymas ir šalies kodas.
`config`	Išsaugoti balso skambučių paskirties, išorinio peradresavimo, SMS paskirties ir SMS peradresavimo laukai. Šis API galinis taškas jų nekeičia.
`features`	Išsaugotos balso, SMS ir MMS galimybių vėliavėlės. Negarantuojama, kad senosios išsaugotos vėliavėlės yra JSON loginės reikšmės.
`status.capacity`	Priskirtų ir naudojamų kanalų reikšmės, kanalų limito viršijimo nuostata ir išsaugotas mokestis už limito viršijimą. Tai išsaugoti metaduomenys, o ne naujas kanalų pajėgumo pasiūlymas ar tikro skambučio bandymas.
`status.origination`	Išsaugoti skambučių kilmės metaduomenys. Identifikatorių vidinės struktūros neinterpretuokite; negrįskite programos logikos vidiniais pavadinimais.
`status.service_active, force_codec, force_dtmf`	Išsaugoti aktyvinimo ir medijos konfigūracijos laukai. Vien vėliavėlė nepatvirtina, kad įeinantis skambutis sėkmingai pasiekia paskirties vietą.
`billing`	Išsaugotos CNAM, kanalų limito viršijimo, pratęsimo, išlaikymo ir sukūrimo reikšmės. Jų nuskaitymas nekeičia pratęsimo ar kitų atsiskaitymo nuostatų.
`price`	Išsaugotos įjungimo, mėnesio ir minutės kainos bei suteikiamų minučių kiekiai. Apdorojimo programa nepateikia valiutos lauko ar naujo kainos pasiūlymo. Nenustatykite valiutos pagal pavyzdines reikšmes ir nenaudokite jų kaip dabartinio įsigijimo kainos pasiūlymo.

Filtravimas ir skaidymas į puslapius

Ši apdorojimo programa neturi skaidymo į puslapius, puslapio dydžio ribos ar aiškiai nustatytos rikiavimo tvarkos. Ji grąžina visus jos užklausa atrinktus neanuliuotus įrašus. Joje nėra filtro, kuris atrinktų tik numerius su aktyvia paslauga, ar atskiro archyvuotų numerių rodinio. Nemanykite, kad grąžinamų įrašų tvarka yra pastovi.

Atitinkančių numerių nėra

Jei paskyroje nėra atitinkančių neanuliuotų įrašų, JSON turinyje pateikiama status.code 404 ir pranešimas, kuriame yra no numbers found. Tuščias masyvas su sėkmės būsena negrąžinamas. Pranešime yra šaltinio nuorodos priesaga, kurios kliento programos neturėtų išskirti ir laikyti pastoviu identifikatoriumi.

Tolesni veiksmai

Naudokite numberinfo kai vienam numeriui reikia papildomų senųjų registracijos ir numerio nuorodos laukų. Prieš keisdami bet kurį maršrutą atskira konfigūravimo operacija, patikrinkite balso skambučių ir pranešimų paskirties vietas.