Listaa ostetut puhelinnumerot

Listaa ostettujen puhelinnumeroiden tietueet, joiden tallennettu omistaja vastaa API-tunnustesi edustamaa tiliä. Tietueen olemassaolo ei tarkoita, että todellisella puhelulla tehty testi olisi onnistunut.

Pyyntö

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

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

Voit suodattaa tulokset yhden tallennetun puhelinnumeron perusteella käyttämällä valinnaista polkumuotoa:

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

Anna tallennettu kansainvälinen puhelinnumero numeroina maatunnus mukaan lukien. Älä anna sen tilalla puhelinvaihteen alanumeroa, puhelinnumeron UUID-tunnistetta, alueen tunnistetta tai etuliitteen tunnistetta. Annettu numero valitsee olemassa olevan tietueen; sillä ei osteta numeroa eikä muuteta sen määrityksiä.

Vastaus

Jäsen response on onnistuneessa vastauksessa aina taulukko, myös yhden numeron polkumuotoa käytettäessä. status.results on taulukon pituus.

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

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

Palautetut puhelinnumeron kentät
Kenttä	Merkitys
`number, uuid, description, isocode`	Tallennettu puhelinnumero, numeron tunniste, jonka sisäistä rakennetta ei ole tarkoitettu tulkittavaksi, kuvaus ja maatunnus.
`config`	Tallennetut puheluiden kohteiden, ulkoisen edelleenohjauksen, tekstiviestikohteen ja tekstiviestien edelleenohjauksen kentät. Tämä rajapintapiste ei muokkaa niitä.
`features`	Tallennetut puhelu-, tekstiviesti- ja multimediaviestitoimintojen liput. Vanhojen tallennettujen lippujen ei taata olevan JSON-totuusarvoja.
`status.capacity`	Varattujen ja käytössä olevien kanavien arvot, ylivuotoasetus ja tallennettu ylitysmaksu. Nämä ovat tallennettuja metatietoja, eivät uusi kapasiteettitarjous eivätkä todellisella puhelulla tehty testi.
`status.origination`	Tallennetut puheluliikenteen alkuperän metatiedot. Käsittele tunnisteita tulkitsematta niiden sisäistä rakennetta; älä johda sovelluslogiikkaa sisäisistä nimistä.
`status.service_active, force_codec, force_dtmf`	Tallennetut aktivoinnin ja mediamääritysten kentät. Pelkkä lippu ei osoita saapuvan liikenteen välittyvän onnistuneesti perille.
`billing`	Tallennetut CNAM-, ylivuoto-, uusimis-, pysyvyys- ja luontiarvot. Niiden lukeminen ei muuta uusimisasetuksia eikä muita laskutusasetuksia.
`price`	Tallennetut avaus-, kuukausi- ja minuuttihinnat sekä hintaan sisältyvät minuuttimäärät. Käsittelijä ei palauta valuuttakenttää eikä uutta hintatarjousta. Älä päättele valuuttaa esimerkkiarvoista äläkä käytä niitä ajantasaisena ostotarjouksena.

Suodatus ja sivutus

Tässä käsittelijässä ei ole sivutusta, sivukoon rajoitusta eikä erikseen määriteltyä lajittelujärjestystä. Se palauttaa kaikki kyselynsä valitsemat tietueet, joita ei ole mitätöity. Se ei tarjoa suodatusta vain aktiivisessa palvelukäytössä oleviin numeroihin eikä erillistä arkistoitujen numeroiden näkymää. Älä oleta palautettujen tietueiden järjestyksen pysyvän samana.

Ei vastaavia numeroita

Jos tilillä ei ole hakua vastaavia tietueita, joita ei ole mitätöity, JSON-rungon kentän status.code arvo on 404 ja rungossa on viesti, joka sisältää tekstin no numbers found. Tällöin ei palauteta tyhjää taulukkoa onnistuneena vastauksena. Viestin lopussa on lähdeviite, jota asiakasohjelmien ei tule jäsentää pysyväksi tunnisteeksi.

Seuraavat vaiheet

Käytä toimintoa numberinfo kun tarvitset yhden numeron vanhat rekisteröinnin ja numeroviitteiden lisäkentät. Tarkista puheluiden ja viestien kohteet ennen kuin muutat mitään reittiä erillisellä määritystoiminnolla.