Kehittäjät

GET/v3/numberinfo/{number}

Lue yhden ostetun numeron tiedot

Lue ostetun puhelinnumeron tallennetut asetukset, tuettujen toimintojen ilmaisimet ja vanhat viitekentät.

Tällä sivulla
  1. Pyyntö
  2. Vastaus
  3. Vastaavaa numeroa ei löydy
  4. Tuloksen käyttäminen

Lue yhden ostetun numeron tietue ja sen tallennetut asetukset. Tämä toiminto palauttaa objektin, kun taas inventory-rajapinta palauttaa taulukon.

Pyyntö

Käytä palvelinpuolen API-tunnuksia HTTPS-yhteyden kautta. Esimerkit lukevat tunnukset ympäristömuuttujista, eivätkä ne sisällä toimivia tunnuksia. Tarkista status.code JSON-rungosta sekä HTTP-tilakoodi. Nämä vanhat käsittelijät eivät aina aseta HTTP-virhetilakoodia sovellusvirheen yhteydessä.

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

Pakollinen polun osa on tallennettu kansainvälinen puhelinnumero, ei sen UUID tai puhelinvaihteen alanumero. Tämä käsittelijä ei käytä kyselyparametreja eikä pyynnön runkoa.

Vastaus

Tämä on havainnollistava esimerkki vastauksen rakenteesta, ei tilin tietoja eikä ajantasainen hintatarjous.

{
  "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"
  }
}
Palautetut numeron kentät
KenttäMerkitys
number, uuid, description, isocodeTallennettu puhelinnumero, numeron tunniste, jonka sisäistä rakennetta ei tule tulkita, kuvaus ja maakoodi.
configTallennetut puhelujen kohteet, ulkoisen edelleenohjauksen kentät, SMS-kohde ja SMS-edelleenohjauksen kentät. Tämä rajapinta ei muokkaa niitä.
featuresTallennetut puhelu-, SMS- ja MMS-tuen ilmaisimet. Vanhojen tallennettujen ilmaisimien ei taata olevan JSON-totuusarvoja.
status.capacityVarattujen ja käytössä olevien kanavien arvot, ylivuotoasetus ja tallennettu ylitysmaksu. Nämä ovat tallennettuja metatietoja, eivät ajantasainen kapasiteettitarjous eivätkä reaaliaikainen puhelutesti.
status.originationTallennetut puhelujen lähtöyhteyden metatiedot. Käsittele tunnisteita tulkitsematta niiden sisäistä rakennetta; älä johda sovelluslogiikkaa sisäisistä nimistä.
status.service_active, force_codec, force_dtmfTallennetut aktivoinnin ja median asetuskentät. Pelkkä ilmaisin ei osoita, että saapuva liikenne välittyy onnistuneesti.
billingTallennetut CNAM-, ylivuoto-, uusimis-, pysyvyys- ja luontiarvot. Niiden lukeminen ei muuta uusimisasetuksia eikä muita laskutusasetuksia.
priceTallennetut avaus-, kuukausi- ja minuuttihinnat sekä sisältyvät minuuttimäärät. Käsittelijä ei anna valuuttakenttää eikä ajantasaista tarjousta. Älä päättele valuuttaa esimerkkiarvoista äläkä käytä niitä ajantasaisena ostotarjouksena.

Verrattuna rajapintaan inventory, tämä rajapinta palauttaa myös kentät needs_registration, vrating, country_id, area_id, provider_id ja price.perminute_charges. Nämä ovat vanhoja tallennettuja arvoja, eivät erillinen henkilöllisyyden hyväksymistä koskeva vastaus. Käsittele viitetunnisteita tulkitsematta niiden sisäistä rakennetta; älä muodosta niistä hakurajapintojen URL-osoitteita äläkä päättele niiden perusteella palveluntarjoajien vastaavuuksia ilman asianmukaista hakurajapinnan vastausta.

Vastaavaa numeroa ei löydy

Jos todennetulta tililtä ei löydy vastaavaa tietuetta, jota ei ole mitätöity, JSON-rungossa on kentän status.code arvona 404 sekä viesti, joka sisältää tekstin number not found. Älä luota viestin lähdekoodiriviä ilmaisevaan loppuosaan. Tarkista tallennettu numero ja inventory ennen uutta yritystä.

Tuloksen käyttäminen

Tämä toiminto lukee tallennettuja tietoja. Se ei osta numeroa, hyväksy henkilöllisyysasiakirjoja, muuta kohdetta eikä takaa puhelun, faksin tai viestin välittymistä. Testaa jokainen käyttöön otettu palvelu erikseen, kun määrität numeron asetuksia.