Ostetud numbrite loendi kuvamine

Kuvage nende ostetud numbrite kirjed, mille salvestatud omanik vastab teie API autentimisandmetega seotud kontole. Kirje olemasolu ei tähenda, et tegeliku kõnega tehtud test oleks õnnestunud.

Päring

Kasutage serveripoolseid API autentimisandmeid HTTPS-i kaudu. Näited loevad autentimisandmed keskkonnamuutujatest; need ei sisalda toimivaid autentimisandmeid. Kontrollige välja status.code JSON-kehas ning ka HTTP olekukoodi. Need pärandpäringutöötlejad ei määra rakenduse vea korral alati HTTP veaolekut.

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

Ühe salvestatud telefoninumbri järgi filtreerimiseks kasutage valikulist URL-i tee kuju:

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

Esitage salvestatud rahvusvaheline telefoninumber numbritena koos riigikoodiga. Ärge edastage selle asemel telefonikeskjaama lühinumbrit, numbri UUID-d, piirkonna ID-d ega prefiksi ID-d. Esitatud number valib olemasoleva kirje; see ei osta ega seadista numbrit.

Vastus

Väli response on õnnestumise korral alati massiiv, ka ühe numbriga URL-i tee kuju korral. status.results näitab massiivi pikkust.

See on vastuse struktuuri näide, mitte konto andmed ega kehtiv hinnapakkumine.

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

Tagastatavad numbri väljad
Väli	Tähendus
`number, uuid, description, isocode`	Salvestatud telefoninumber, numbri identifikaator, mille sisemist struktuuri ei tule tõlgendada, kirjeldus ja riigikood.
`config`	Salvestatud kõnesihtkohtade, välise suunamise, SMS-i sihtkoha ja SMS-ide edastamise väljad. See lõpp-punkt neid ei muuda.
`features`	Salvestatud kõne-, SMS- ja MMS-võimekuse lipud. Pärandsüsteemis salvestatud lipud ei pruugi olla JSON-i tõeväärtused.
`status.capacity`	Määratud ja kasutatud kanalite väärtused, ülevoolu seadistus ning salvestatud ületustasu. Need on salvestatud metaandmed, mitte värske kanalimahtu puudutav hinnapakkumine ega tegeliku kõnega tehtud test.
`status.origination`	Salvestatud metaandmed kõnede lähtekoha kohta. Ärge tõlgendage identifikaatorite sisemist struktuuri; ärge tuletage rakenduse loogikat sisemistest nimedest.
`status.service_active, force_codec, force_dtmf`	Salvestatud aktiveerimise ja meediumiseadistuse väljad. Üksnes lipp ei tõenda sissetuleva kõne edukat kohalejõudmist.
`billing`	Salvestatud CNAM-i, ülevoolu, uuendamise, püsivuse ja loomise väärtused. Nende lugemine ei muuda uuendamise ega muid arveldusseadeid.
`price`	Salvestatud liitumistasu, kuutasu, minutihind ja hinnas sisalduvate minutite mahud. Päringutöötleja ei väljasta valuutavälja ega värsket hinnapakkumist. Ärge tuletage näidisväärtustest valuutat ega kasutage neid kehtiva ostupakkumisena.

Filtreerimine ja lehekülgedeks jaotamine

Sellel päringutöötlejal puuduvad lehekülgedeks jaotamine, lehekülje suuruse piirang ja selgesõnaliselt määratud sortimisjärjestus. See tagastab kõik oma päringuga valitud tühistamata kirjed. See ei paku filtrit ainult aktiivse teenusega kirjete jaoks ega eraldi arhiveeritud numbrite vaadet. Ärge eeldage, et tagastatud kirjete järjekord on püsiv.

Vastavaid numbreid ei leitud

Kui kontol pole vastavaid tühistamata kirjeid, on JSON-kehas välja status.code väärtus 404 ning teade sisaldab teksti no numbers found. Tühja massiivi eduka vastusena ei tagastata. Teade sisaldab lähtekoodiviitega järelliidet, mida klientrakendused ei tohiks parsida püsiva identifikaatorina.

Järgmised sammud

Kasutage lõpp-punkti numberinfo siis, kui vajate ühe numbri kohta täiendavaid pärandsüsteemi registreerimis- ja numbriviitevälju. Kontrollige kõnede ja sõnumite sihtkohti enne mis tahes marsruudi muutmist eraldi seadistustoiminguga.