Kūrėjams

GET/v3/get_document_number_types/{country}

Registracijai skirtų numerių tipų sąrašas

Raskite numerių tipų pavadinimus, šiuo metu pateikiamus konkrečios šalies registracijos kataloge.

Šiame puslapyje
  1. Pasirinkite tipą pagal grąžintą jo pavadinimą
  2. Grupių skaičius neatspindi turimų numerių kiekio
  3. Užklausa
  4. Atsakymas
  5. Klaidos
  6. Prieinamumas ir šalutinis poveikis

Pasirinkite tipą pagal grąžintą jo pavadinimą

Naudokite šalį iš get_document_countries. Grąžintą tipo pavadinimą perduokite funkcijai get_requirements. Tipo katalogo ID nėra prefikso ID, numerio ID ar patvirtinamojo dokumento kategorijos ID.

Grupių skaičius neatspindi turimų numerių kiekio

available_groups nurodo šios katalogo paieškos grąžintų grupių įrašų skaičių. Šis rodiklis neskaičiuoja galimų įsigyti telefono numerių, nerezervuoja turimų numerių ir negarantuoja, kad katalogas apėmė visus pirminio duomenų šaltinio puslapius. Atskirai atlikite paiešką atitinkamame turimų numerių sąraše ir peržiūrėkite kainos pasiūlymą.

Užklausa

Naudokite savo įgalintos API paskyros prisijungimo duomenis per HTTPS. Palaikomas Basic autentifikavimas ir įgalinti API paskyros bearer prieigos raktai; taikomi paskyros apribojimai.

GET užklausa su bet kuriuo dokumentacijoje nurodytu parametru URL kelyje.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Kelio parametrai
PavadinimasTipasPrivalomasAprašymas
countrystringTaipDviejų raidžių šalies ISO kodas iš registracijai skirtų šalių katalogo. Jo pradžioje ir pabaigoje esantys tarpai pašalinami, o raidės pakeičiamos didžiosiomis.

Atsakymas

Patikrinkite status.code JSON turinyje ir HTTP būseną. response yra masyvas, kuriame pateikiami id, name ir available_groups. Naudokite name kaip number_type, kai kviečiate get_requirements; vietoj jo nesiųskite id. available_groups yra tam tipui grąžintų grupių įrašų skaičius, o ne turimų telefono numerių skaičius ar bendras visų puslapių įrašų skaičius. Tipai, kuriems negrąžinta jokių grupių, nepateikiami. Pirmenybė teikiama šiai tvarkai: Local, Mobile, National, Toll Free, Shared Cost, Global, po jų pateikiami kiti katalogo pavadinimai.

Pavyzdinė atsakymo struktūra; tai nėra tikrieji paskyros duomenys ar dabartinis kainos pasiūlymas.

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

Klaidos

  • 400: country is required: pateikite registracijai skirtos šalies ISO kodą.
  • 400: Invalid country ISO or no available DID registration country found: pasirinkite šalį iš dabartinio registracijos katalogo; tai nepatvirtina, kad nereikia jokių dokumentų.

Prieinamumas ir šalutinis poveikis

  • Ši katalogo ar reikalavimų paieška nesukuria tapatybės įrašo, neįkelia patvirtinamojo dokumento, neregistruoja numerio ir nepateikia užsakymo.
  • Sėkmingas katalogo atsakymas nereiškia, kad jūsų dokumentai patvirtinti arba kad pasirinktą numerį galima aktyvuoti.