Fejlesztők

GET/v3/get_document_number_types/{country}

Regisztrációs számtípusok listázása

Lekérdezheti az adott ország regisztrációs katalógusában jelenleg szereplő számtípusok nevét.

Ezen az oldalon
  1. Válasszon típust a válaszban kapott neve alapján
  2. A csoportok száma nem a telefonszámkészletet jelzi
  3. Kérés
  4. Válasz
  5. Hibák
  6. Elérhetőség és mellékhatások

Válasszon típust a válaszban kapott neve alapján

Válasszon országot a következő végpont által visszaadott listából: get_document_countries. A válaszban kapott típusnevet adja át a következő végpontnak: get_requirements. A típus katalógusbeli azonosítója nem előhívó-azonosító, telefonszám-azonosító vagy igazoláskategória-azonosító.

A csoportok száma nem a telefonszámkészletet jelzi

available_groups az e katalóguslekérdezés által visszaadott csoportrekordokat számolja. Nem a megvásárolható telefonszámokat számolja, nem foglal le készletet, és nem garantálja, hogy a katalógus az adatforrás összes lapját feldolgozta. A megfelelő telefonszámkészletben külön keressen, és külön tekintse át az árajánlatot.

Kérés

Használja engedélyezett API-fiókjának hitelesítő adatait HTTPS-kapcsolaton keresztül. A Basic hitelesítés és az engedélyezett API-fiókhoz tartozó bearer tokenek támogatottak; a fiókra vonatkozó korlátozások érvényesek.

GET kérés, amelyben minden dokumentált paraméter az URL elérési útjában szerepel.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Elérésiút-paraméterek
NévTípusKötelezőLeírás
countrystringIgenKétbetűs ISO-országkód a regisztrációhoz elérhető országok katalógusából. Az elejéről és a végéről a rendszer eltávolítja a szóközöket, és nagybetűssé alakítja.

Válasz

Ellenőrizze a status.code értékét a JSON-törzsben, valamint a HTTP-állapotot is. A response olyan tömb, amelynek elemei az id, name és available_groups mezőket tartalmazzák. A name értékét adja meg a number_type paraméterként a get_requirements hívásakor; ne küldje helyette az id értékét. Az available_groups az adott típushoz visszaadott csoportrekordok száma, nem a készleten lévő telefonszámok száma vagy az összes lap teljes összesített darabszáma. Azok a típusok, amelyekhez nem érkezett vissza csoport, kimaradnak. Az előnyben részesített sorrend: Local, Mobile, National, Toll Free, Shared Cost, Global, majd a katalógusban szereplő többi név.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Hibák

  • 400: country is required: adja meg a regisztrációhoz használt ország ISO-kódját.
  • 400: Invalid country ISO or no available DID registration country found: válasszon országot az aktuális regisztrációs katalógusból; ez nem jelenti azt, hogy nincs szükség dokumentumokra.

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

  • Ez a katalógus- és követelménylekérdezés nem hoz létre személyazonossági profilt, nem tölt fel igazolást, nem regisztrál telefonszámot, és nem ad le megrendelést.
  • A sikeres katalógusválasz nem jelenti a dokumentumai jóváhagyását, és nem erősíti meg, hogy a kiválasztott telefonszám aktiválható.