Fejlesztők

GET/v3/getnumbers/{prefix_id}/{quantity}

Elérhető telefonszámok keresése

Keressen egy katalógusbeli prefixen belül, tekintse át a számok képességeit és a fiókra szabott díjcsomagokat, majd válasszon számot egy külön rendeléshez. A keresés nem foglal le és nem vásárol meg számot.

Ezen az oldalon
  1. Egyedi prefix kiválasztása
  2. Korlátozott méretű eredménycsoport böngészése
  3. Könnyen megjegyezhető számjegyminta keresése
  4. A kiválasztott szám áttekintése
  5. Külön rendelés és az eredmény ellenőrzése
  6. Kérés
  7. Válasz
  8. Hibák
  9. Elérhetőség és mellékhatások

Egyedi prefix kiválasztása

Használja az országok és körzetek keresési hívásait, majd ezt: getprefixes csoportosítás nélkül. Másolja ki a kiválasztott prefix uuid értékét. Ha a returns_numbers értéke 0, a prefixhez rendeléskor rendelnek számot; használja a visszaadott next_function értéket ahelyett, hogy megkövetelné az egyedi számok listáját.

Korlátozott méretű eredménycsoport böngészése

Szokásos kereséshez használja ezt: compact=1, és adja meg a kívánt csoportméretet az útvonalban és a quantity lekérdezési paraméterben is, az alábbi példa szerint. Nincs oldal- vagy kurzorparaméter. A tömör eredmény egy minta; a kérés megismétlése nem garantál átfedésmentes következő oldalt. Az üres vagy kis méretű eredményt ne értelmezze a teljes készlet darabszámaként.

Könnyen megjegyezhető számjegyminta keresése

Adja meg ezt: number_filter_mode=contains vagy ezt: ends_with, ezzel együtt: number_filter_value. Az értéknek 1–15 számjegyet kell tartalmaznia. A keresés a szűrő alkalmazása előtt korlátozott méretű jelöltcsoportokat kérhet le, ezért más megfelelő készletelemek kimaradhatnak. Ha a kötelező kereséshez támogatott forrást kell használnia, kérjen egy pid választót a MultiTEL-től, és használja ezt: filter_required=1; hiányzó vagy nem támogatott választás esetén API-hiba érkezik.

A kiválasztott szám áttekintése

Olvassa ki ezeket: number, info.uuid, a kiválasztott price[].uuid, az elérhető képességek nevei és a regisztrációs követelmények, ugyanabból az eredményből. A price tömb több, eltérő csatornaszámú és díjazású csomagot is kínálhat. A pénzösszegeket tartalmazó mezők és a mennyiségek karakterláncként is kódolhatók. A nem kötelező metaadatok, köztük az info.state, forrásonként eltérnek; ne követeljen meg egységes államadat-szerkezetet, és ne következtessen árakra azonosítóból.

A nem folyamatos adatküldésű feldolgozási útvonalon a jelöltek ismétlődéseit kiszűrik, és az eredménykeretet elosztják a források között, mielőtt a kiválasztott csoportot az első csomag havi ára alapján rendezik. Más útvonalak korábban megkezdhetik az adatok folyamatos küldését, ezért nem vonatkozik minden kérésre globális rendezési vagy ismétlődéskiszűrési garancia. A rendezés azt sem bizonyítja, hogy a visszaadott minta a teljes katalógus legolcsóbb számát tartalmazza.

Külön rendelés és az eredmény ellenőrzése

A keresés semmit nem vásárol meg és nem foglal le. Őrizze meg a visszaadott szám- és csomagazonosítókat az ugyanazon fiókban végzett rendelési folyamathoz. Rendelés elküldése előtt tekintse át a tényleges csomagot, a követelményeket és a díjakat. A regisztrációs követelmények késleltethetik az aktiválást; a keresési eredmény nem határoz meg rögzített aktiválási határidőt.

Kérés

Használjon engedélyezett MultiTEL API-fiókot: jelszavas fióknál HTTP Basic hitelesítési adatokat, tokenes fióknál pedig Authorization: Bearer fejlécet. A fiók jogosultságai és IP-korlátozásai érvényesek. Lásd az általános hitelesítési útmutatót.

Útvonalparaméterek és URL-lekérdezési paraméterek. A nyilvános keresési munkafolyamathoz használjon GET kérést. A kéréskezelő bizonyos űrlap- és kérésértékeket is elfogad, de ez nem JSON-törzsű keresési API.

curl --fail-with-body --get \
  --user "${MULTITEL_API_USERNAME}:${MULTITEL_API_PASSWORD}" \
  --data-urlencode "compact=1" \
  --data-urlencode "quantity=10" \
  "https://api.multitel.net/v3/getnumbers/${PREFIX_ID}/10"
Útvonalparaméterek
NévTípusKötelezőLeírás
prefix_idstringIgenA getprefixes csoportosítás nélküli válaszában visszaadott egyedi prefixazonosító. Pontosan másolja ki; ne helyettesítse ország-, körzet-, csoportosítottprefix- vagy díjcsomag-azonosítóval.
quantityintegerNemA lekérés célmennyisége, alapértelmezés szerint 1. A nem pozitív értékek helyett 1 lesz érvényes. Az útvonalban megadott quantity önmagában nem megbízható korlátja a teljes eredménymennyiségnek: egy adott forráshoz nem rögzített keresés quantity lekérdezési paraméter nélkül kibővítheti a lekérést, és a további feldolgozás előtt forrásonként legfeljebb 50 bejegyzést adhat vissza. Szokásos, korlátozott méretű böngészéshez használja a compact=1 beállítást, és a kívánt mennyiséget ismételje meg a lekérdezésben is, a példa szerint.
Lekérdezési paraméterek
NévTípusKötelezőLeírás
quantityintegerNemA végső eredménycsoport kért mérete. A nem üres értékeket a rendszer egész számmá alakítja, legalább 1 értékkel. Az adott forráshoz nem rögzített, nem folyamatos adatküldésű útvonalon ez korlátozza a végső kiosztott mennyiséget. Nem kötelezi a szolgáltatást ennyi szám megtalálására. Az egy forráshoz rögzített tömör keresések e korlát helyett a forrás tömör eredménycsoportját is visszaadhatják.
compactstringNemKisebb, nem folyamatos adatküldésű válaszhoz használja az 1, true vagy on értéket; a végső kiosztás előtt forrásonként legfeljebb 10 bejegyzés szerepelhet. Az eredmények az aktuálisan lekért készlet mintáját alkotják, nem a teljes katalógust.
number_filter_modestringNemNem kötelező számjegyminta-mód: contains vagy ends_with. Adja meg a number_filter_value paramétert is. Az eredményeket a telefonszámok normalizált számjegyeivel vetik össze; a keresés nem járja be a teljes készletet az összes lehetséges találat garantálásához.
number_filter_valuestringNem1 és 15 közötti számjegy, szóközök, + jel és írásjelek nélkül. A kezdő nullák számítanak; szövegként küldje el.
filter_requiredstringNemHaladó beállítás: az 1, true, yes vagy on érték a szűrési módhoz támogatott, kifejezetten kiválasztott készletforrást követel meg. Ellenkező esetben az API által visszaadott status.code értéke 422. A katalógus szokásos böngészéséhez erre nincs szükség.
pidstringNemA MultiTEL által biztosított haladó készletválasztó. Számalak és támogatott, 32 karakteres hexadecimális alak fogadható el; az ismeretlen értékeket a rendszer jelzés nélkül figyelmen kívül hagyja. Szokásos használat esetén hagyja el. Ne származtasson választókat árazonosítókból, és ne feltételezze, hogy egy tetszőleges választó kizárólagosan korlátozza a készletet.

Válasz

Egyetlen JSON-objektum, amely status és response mezőt tartalmaz. Siker esetén a status.code értéke 200, a response pedig számbejegyzések tömbje. A status.results a visszaadott tömb elemszáma; a status.msg értéke Results: N, folyamatos adatküldésű válasznál pedig OK is lehet. A compact=1 nélkül egyes keresések fokozatosan írják ki a response tömböt, és a status mezővel zárulnak, ezért várja meg a teljes JSON-törzset. Ez nem újsorokkal elválasztott JSON. Sikeres HTTP-adatátvitel esetén is ellenőrizze a status.code értékét. Az alábbiakban a jellemző mezők láthatók; a forrásspecifikus metaadatok és a nem kötelező mezők eltérnek. Minden azonosítót kezeljen önmagában nem értelmezendő értékként, és a számot a kiválasztott price[].uuid értékével együtt őrizze meg.

A válasz szerkezetét szemléltető példa; nem élő fiókadat vagy aktuális árajánlat.

{
  "status": {
    "code": 200,
    "msg": "Results: 1",
    "results": 1
  },
  "response": [
    {
      "number": "12125550123",
      "info": {
        "uuid": "NUMBER_ID_FROM_RESPONSE",
        "prefix_uuid": "PREFIX_ID_FROM_RESPONSE",
        "area_uuid": "AREA_ID_FROM_RESPONSE",
        "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
        "country_iso": "US",
        "prefix": "+1212",
        "name": "Example area",
        "state": "US"
      },
      "price": [
        {
          "uuid": "PRICE_PLAN_ID_FROM_RESPONSE",
          "per_minute": "0.01",
          "per_sms": "0",
          "per_mms": "0",
          "free_minutes": "0",
          "setup_price": "1.00",
          "monthly_price": "2.00",
          "yearly_price": "0",
          "channels": "2"
        }
      ],
      "contract": {
        "term": "1 month",
        "renewal": "monthly",
        "notice": "none"
      },
      "restrictions": {
        "needs_registration": "0",
        "restrictions": ""
      },
      "features": [
        "voice"
      ],
      "overflow": "0"
    }
  ]
}

Hibák

  • 401: Sikertelen hitelesítés. Érvénytelen vagy hiányzó hitelesítési adatok és elutasított API-fiók-hozzáférés esetén nem keletkeznek keresési eredmények.
  • 404: Invalid prefix ID, Invalid country, Invalid area vagy No numbers found. Olvassa el a status.msg értékét; a hibaválasz nem számtömb.
  • 400: NUMBER_FILTER_INVALID a response.code mezőben: érvénytelen mód, nem 1–15 számjegyből álló érték, vagy filter_required a mód és az érték együttes megadása nélkül.
  • 422: NUMBER_FILTER_UNSUPPORTED a response.code mezőben: vagy a prefixhez rendeléskor rendelnek számot (reason=order_only_prefix, és a next_function azonosítja a rendelési útvonalat), vagy a kifejezetten kiválasztott forrás nem támogatja a megkövetelt szűrőt.

Elérhetőség és mellékhatások

  • Ez a kéréskezelő keresést végez és árajánlatokat készít; nem küld el számrendelést, és nem von le számvásárlási díjat. Frissítheti a katalógus gyorsítótárait, eltávolíthatja az elavult gyorsítótárazott készletadatokat, fiókhoz kötött díjcsomagokat menthet, és keresési naplókat írhat.
  • Az elérhetőség egy adott időpontra vonatkozó eredmény, nem foglalás. Egy későbbi rendelés sikertelen lehet, vagy eltérő elérhetőséget adhat vissza. A vásárlás újbóli megkísérlése előtt egyeztesse a rendelés eredményét.
  • Az árak fiókspecifikusak. A kiválasztott csomag azonosítóját ugyanahhoz a fiókhoz őrizze meg, és külön tekintse át a rendelési feltételeket és díjakat; ez a végpont önmagában nem bizonyítja, hogy az ár egy későbbi rendelésig érvényes marad.
  • A példában szereplő szám és árak kitalált, a válasz szerkezetét szemléltető adatok, nem élő árajánlat. A képességeket, a csatornaszámokat, az időtartamot és a regisztrációs információkat a ténylegesen kiválasztott eredményből kell kiolvasni.
  • Egyes regisztrációs leírások formázott szöveget vagy hivatkozásokat tartalmaznak. Saját alkalmazásában történő megjelenítéskor a visszaadott karakterláncokat nem megbízható adatként kezelje.
  • A mobilszámok elérhetősége és a jelzők a fiók jogosultságától és a készlettől függenek. Egy katalógusbeli prefix vagy az is_mobile jelző önmagában nem állapítja meg egy adott szám mobilképességeit.