Fejlesztők

GET/v3/inventory/{number}

A megvásárolt telefonszámok listázása

A megvásárolt telefonszámok konfigurációjának és tárolt állapotának lekérdezése, igény szerint telefonszám szerinti szűréssel.

Ezen az oldalon
  1. Kérés
  2. Válasz
  3. Szűrés és lapozás
  4. Nincs megfelelő telefonszám
  5. Következő lépések

Azon megvásárolt telefonszámok rekordjainak listázása, amelyek tárolt tulajdonosa megegyezik az API-hitelesítő adatokhoz tartozó fiókkal. Egy rekord megléte önmagában nem jelent sikeres, tényleges hívással végzett tesztet.

Kérés

Használjon szerveroldali API-hitelesítő adatokat HTTPS-kapcsolaton keresztül. A példák környezeti változókból olvassák be a hitelesítő adatokat; működő hitelesítő adatokat nem tartalmaznak. Ellenőrizze a status.code értékét a JSON-törzsben, valamint a HTTP-állapotkódot is. Ezek a régi kezelők alkalmazáshiba esetén nem állítanak be következetesen HTTP-hibakódot.

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

Egyetlen tárolt telefonszámra való szűréshez használja az opcionális útvonalformát:

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

A tárolt nemzetközi telefonszámot számjegyekkel, az országhívószámmal együtt adja meg. Ne adjon meg helyette PBX-melléket, telefonszámhoz tartozó UUID-t, területazonosítót vagy előtagazonosítót. A megadott szám egy meglévő rekordot választ ki; nem vásárol és nem konfigurál telefonszámot.

Válasz

A response tag siker esetén mindig tömb, az egyetlen telefonszámot megadó útvonalforma esetében is. A status.results a tömb hossza.

Ez a válasz szerkezetét szemléltető példa, nem fiókadat vagy aktuális árajánlat.

{
  "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"
      }
    }
  ]
}
A visszaadott telefonszámmezők
MezőJelentés
number, uuid, description, isocodeA tárolt telefonszám, a telefonszám belső jelentés nélküli azonosítója, a leírás és az országkód.
configA hanghívások tárolt célpontjai, a külső hívásátirányítás, az SMS-célpont és az SMS-továbbítás mezői. Ez a végpont nem módosítja ezeket.
featuresA hanghívási, SMS- és MMS-képességek tárolt jelzői. A régi tárolt jelzők nem feltétlenül JSON logikai értékek.
status.capacityA hozzárendelt és a használt csatornák értékei, a túlcsordulási beállítás és a tárolt túllépési díj. Ezek tárolt metaadatok, nem friss kapacitásajánlat vagy tényleges hívással végzett teszt eredményei.
status.originationA híváseredetre vonatkozó tárolt metaadatok. Az azonosítókat kezelje belső jelentés nélküli értékekként; ne vezessen le alkalmazáslogikát a belső nevekből.
status.service_active, force_codec, force_dtmfAz aktiválás és a médiakonfiguráció tárolt mezői. Egy jelző önmagában nem bizonyítja a bejövő hívások sikeres célba jutását.
billingA CNAM, a túlcsordulás, a megújítás, a tartós megőrzés és a létrehozás tárolt értékei. Kiolvasásuk nem módosítja a megújítási vagy más számlázási beállításokat.
priceA tárolt beállítási díjak, havidíjak, percdíjak és perckeretek. A kezelő nem ad vissza pénznemmezőt vagy friss árajánlatot. A példaértékekből ne következtessen a pénznemre, és ne használja őket aktuális vásárlási árajánlatként.

Szűrés és lapozás

Ez a kezelő nem biztosít lapozást, oldalméret-korlátot vagy kifejezetten meghatározott rendezési sorrendet. A lekérdezése által kiválasztott összes nem érvénytelenített rekordot visszaadja. Nem biztosít kizárólag aktív szolgáltatású rekordokra szűrést vagy külön nézetet az archivált telefonszámokhoz. Ne feltételezze, hogy a visszaadott rekordok sorrendje állandó.

Nincs megfelelő telefonszám

Ha a fiókhoz nem tartozik megfelelő, nem érvénytelenített rekord, a JSON-törzsben a status.code értéke 404, és az üzenet tartalmazza a következőt: no numbers found. Nem ad vissza üres tömböt sikeres válaszként. Az üzenet forráshivatkozást tartalmazó utótaggal rendelkezik, amelyet a klienseknek nem szabad állandó azonosítóként feldolgozniuk.

Következő lépések

Használja a numberinfo végpontot, ha egy telefonszámhoz szüksége van a további régi regisztrációs és telefonszám-hivatkozási mezőkre. Ellenőrizze a hanghívások és az üzenetek célpontjait, mielőtt külön konfigurációs művelettel bármely útvonalat módosítana.