Kūrėjams

GET/v3/numberinfo/{number}

Gauti vieno įsigyto numerio duomenis

Gauti įsigyto telefono numerio išsaugotą konfigūraciją, galimybių požymius ir senosios sistemos nuorodų laukus.

Šiame puslapyje
  1. Užklausa
  2. Atsakas
  3. Atitinkančio numerio nėra
  4. Rezultato naudojimas

Gauti vieno įsigyto numerio įrašą ir jo išsaugotą konfigūraciją. Ši operacija grąžina objektą, o ne masyvą, kurį grąžina inventory galinis taškas.

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 sistemos apdorojimo funkcijos ne visada nustato HTTP klaidos būseną, kai įvyksta programos klaida.

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

Privalomas kelio segmentas yra išsaugotas tarptautinis telefono numeris, o ne jo UUID ar PBX vidinis numeris. Ši apdorojimo funkcija nenaudoja nei užklausos parametrų, nei užklausos turinio.

Atsakas

Tai pavyzdinė atsako struktūra, o ne paskyros duomenys ar dabartinis kainos pasiūlymas.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "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",
      "perminute_charges": "0"
    },
    "needs_registration": "0",
    "vrating": "",
    "country_id": "COUNTRY_REFERENCE",
    "area_id": "AREA_REFERENCE",
    "provider_id": "OPAQUE_LEGACY_REFERENCE"
  }
}
Grąžinami numerio laukai
LaukasReikšmė
number, uuid, description, isocodeIšsaugotas telefono numeris, numerio identifikatorius, kurio vidinės struktūros interpretuoti nereikia, aprašas ir šalies kodas.
configIšsaugoti balso skambučių paskirties, išorinio peradresavimo, SMS paskirties ir SMS peradresavimo laukai. Šis galinis taškas jų nekeičia.
featuresIšsaugoti balso skambučių, SMS ir MMS galimybių požymiai. Negarantuojama, kad senosios sistemos išsaugoti požymiai yra JSON loginės reikšmės.
status.capacityPriskirtų ir naudojamų kanalų reikšmės, kanalų skaičiaus viršijimo nuostata ir išsaugotas mokestis už viršijimą. Tai išsaugoti metaduomenys, o ne naujas kanalų pajėgumo pasiūlymas ar skambučio bandymas realiuoju laiku.
status.originationIšsaugoti skambučių kilmės metaduomenys. Neinterpretuokite identifikatorių vidinės struktūros; negrįskite programos logikos vidiniais pavadinimais.
status.service_active, force_codec, force_dtmfIšsaugoti aktyvinimo ir medijos konfigūracijos laukai. Vien požymis neįrodo, kad įeinantis ryšys sėkmingai pasiekia paskirties vietą.
billingIšsaugotos CNAM, kanalų skaičiaus viršijimo, pratęsimo, išlaikymo ir sukūrimo reikšmės. Jų nuskaitymas nekeičia pratęsimo ar kitų atsiskaitymo nuostatų.
priceIšsaugotos prijungimo, mėnesio ir minutės kainos bei suteikiamų minučių kiekiai. Apdorojimo funkcija nepateikia nei valiutos lauko, nei naujo kainos pasiūlymo. Nespręskite apie valiutą iš pavyzdinių reikšmių ir nenaudokite jų kaip dabartinio pirkimo kainos pasiūlymo.

Palyginti su inventory, šis galinis taškas taip pat grąžina needs_registration, vrating, country_id, area_id, provider_id ir price.perminute_charges. Tai senosios sistemos išsaugotos reikšmės, o ne atskiras tapatybės patvirtinimo atsakas. Nuorodų identifikatorių vidinės struktūros interpretuoti nereikėtų; neturėdami atitinkamo paieškos atsako, iš jų nekurkite paieškos URL ir nespręskite apie sąsajas su teikėjais.

Atitinkančio numerio nėra

Jei autentifikuotoje paskyroje nerandama atitinkančio neanuliuoto įrašo, JSON turinyje pateikiamas status.code 404 ir pranešimas, kuriame yra number not found. Nesiremkite jo priesaga, nurodančia šaltinio kodo eilutę. Prieš bandydami dar kartą, patikrinkite išsaugotą numerį ir inventory.

Rezultato naudojimas

Ši operacija nuskaito išsaugotus duomenis. Ji neįsigyja numerio, nepatvirtina tapatybės dokumentų, nekeičia paskirties vietos ir negarantuoja, kad skambutis, faksas ar žinutė pasieks gavėją. Konfigūruodami numerį, kiekvieną įjungtą paslaugą išbandykite atskirai.