Izstrādātājiem

GET/v3/numberinfo/{number}

Nolasīt viena iegādāta numura datus

Nolasīt iegādāta tālruņa numura saglabāto konfigurāciju, iespēju karodziņus un mantotos atsauču laukus.

Šajā lapā
  1. Pieprasījums
  2. Atbilde
  3. Nav atbilstoša numura
  4. Rezultāta izmantošana

Nolasīt viena iegādāta numura ierakstu un tā saglabāto konfigurāciju. Šī darbība atgriež objektu, nevis masīvu, ko atgriež galapunkts inventory.

Pieprasījums

Izmantojiet servera puses API piekļuves datus ar HTTPS. Piemēros piekļuves dati tiek nolasīti no vides mainīgajiem; tajos nav derīgu piekļuves datu. Pārbaudiet status.code JSON atbildes saturā, kā arī HTTP statusu. Šie mantotie apstrādātāji lietojumprogrammas kļūdas gadījumā ne vienmēr iestata HTTP kļūdas statusu.

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

Obligātais ceļa segments ir saglabātais starptautiskais tālruņa numurs, nevis tā UUID vai PBX iekšējais numurs. Šis apstrādātājs neizmanto vaicājuma parametrus vai pieprasījuma saturu.

Atbilde

Šis ir ilustratīvs atbildes struktūras piemērs, nevis konta dati vai aktuāls cenas piedāvājums.

{
  "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"
  }
}
Atgrieztie numura lauki
LauksNozīme
number, uuid, description, isocodeSaglabātais tālruņa numurs, numura identifikators bez interpretējamas iekšējās struktūras, apraksts un valsts kods.
configSaglabātie balss zvanu galamērķu, ārējās pāradresācijas, SMS galamērķa un SMS pāradresācijas lauki. Šis galapunkts tos nemaina.
featuresSaglabātie balss zvanu, SMS un MMS iespēju karodziņi. Nav garantijas, ka mantotie saglabātie karodziņi ir JSON loģiskās vērtības.
status.capacityPiešķirto un izmantoto kanālu vērtības, pārplūdes iestatījums un saglabātā maksa par limita pārsniegšanu. Tie ir saglabāti metadati, nevis aktuāls kapacitātes piedāvājums vai reāla zvana pārbaude.
status.originationSaglabātie zvanu izcelsmes metadati. Uztveriet identifikatorus kā vērtības bez interpretējamas iekšējās struktūras; neatvasiniet lietojumprogrammas loģiku no iekšējiem nosaukumiem.
status.service_active, force_codec, force_dtmfSaglabātie aktivizācijas un multivides konfigurācijas lauki. Karodziņš pats par sevi neapliecina veiksmīgu ienākošās saziņas piegādi.
billingSaglabātās CNAM, pārplūdes, atjaunošanas, pastāvīguma un izveides vērtības. To nolasīšana nemaina atjaunošanas vai citus norēķinu iestatījumus.
priceSaglabātās pieslēgšanas, mēneša un minūtes cenas, kā arī iekļauto minūšu apjomi. Apstrādātājs nesniedz valūtas lauku vai aktuālu cenas piedāvājumu. Neizdariet secinājumus par valūtu no piemēra vērtībām un neizmantojiet tās kā aktuālu iegādes cenas piedāvājumu.

Salīdzinājumā ar inventory, šis galapunkts atgriež arī needs_registration, vrating, country_id, area_id, provider_id un price.perminute_charges. Tās ir mantotas saglabātās vērtības, nevis atsevišķa identitātes apstiprināšanas atbilde. Atsauču identifikatori jāuztver kā vērtības bez interpretējamas iekšējās struktūras; bez atbilstošās atklāšanas atbildes neveidojiet no tiem atklāšanas URL un neizdariet secinājumus par atbilstību pakalpojumu sniedzējiem.

Nav atbilstoša numura

Ja autentificētajam kontam netiek atrasts atbilstošs neanulēts ieraksts, JSON atbildes saturā ir status.code 404 un ziņojums, kas satur number not found. Nepaļaujieties uz ziņojuma beigu daļu ar avota rindas norādi. Pirms atkārtota mēģinājuma pārbaudiet saglabāto numuru un inventory.

Rezultāta izmantošana

Šī darbība nolasa saglabātos datus. Tā neiegādājas numuru, neapstiprina personu apliecinošus dokumentus, nemaina galamērķi un negarantē zvana, faksa vai ziņojuma piegādi. Konfigurējot numuru, pārbaudiet katru iespējoto pakalpojumu atsevišķi.