Kūrėjams

POST/v3/get_requirements

Peržiūrėti registracijos reikalavimus

Gaukite registracijos reikalavimus, šiuo metu grąžinamus pagal šalį ir numerio tipo pavadinimą.

Šiame puslapyje
  1. Pasirinkite šalį ir numerio tipą
  2. Perskaitykite grąžintas instrukcijas
  3. Nelaikykite klaidos atleidimu nuo registracijos
  4. Užklausa
  5. Atsakymas
  6. Klaidos
  7. Prieinamumas ir šalutinis poveikis

Pasirinkite šalį ir numerio tipą

Pasirinkite registracijos šalį, tada naudokite pavadinimą, kurį grąžina get_document_number_types. Šį pavadinimą pateikite kaip number_type, o ne tipo identifikatorių ar bendrą numerių paieškos kategoriją.

Perskaitykite grąžintas instrukcijas

Išsaugokite reikalavimo ir ryšių identifikatorius atitinkamai tapatybės ir dokumentų tvarkymo eigai. Ši iškvieta grąžina reikalavimus; ji netikrina ir nepateikia jūsų failų. Laikykitės grąžintų instrukcijų ir visų pasirinktam numeriui taikomų specialių reikalavimų.

Nelaikykite klaidos atleidimu nuo registracijos

Klaida apie netinkamą šalį arba tai, kad nereikia šalies registracijos dokumentų, apima dvi sąlygas. Ji neįrodo, kad registracija nereikalinga. Nepavykusi paieška arba tuščias rezultatas taip pat nereiškia, kad klientas ar numeris patvirtintas. Jei rezultatas neaiškus, kreipkitės į pagalbos tarnybą.

Užklausa

Naudokite savo įgalintos API paskyros prisijungimo duomenis per HTTPS. Palaikomas bazinis autentifikavimas ir įgalinti API paskyros prieigos žetonai, pateikiami pagal Bearer schemą; taikomi paskyros apribojimai.

POST su application/json arba application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"
Užklausos turinio parametrai
PavadinimasTipasPrivalomasAprašymas
countryTeksto eilutėTaipŠalies ISO kodas, gautas iš get_document_countries.
number_typeTeksto eilutėTaipTipo pavadinimas, gautas iš get_document_number_types, pavyzdžiui, Local; lyginant neskiriamos didžiosios ir mažosios raidės. Pateikite pavadinimą, o ne jo identifikatorių.

Atsakymas

Patikrinkite status.code JSON turinyje ir HTTP būseną. response yra vienas reikalavimų išteklius su id, type ir attributes, taip pat su relationships, jei jie grąžinami. Ištekliaus ir ryšių duomenyse esantys identifikatoriai neturi interpretuotinos vidinės struktūros. Iš neprivalomo restriction_message teksto pašalinamos HTML žymos; likusį tekstą apdorokite kaip tekstą, o ne kaip patikimą HTML. Apdorojimo funkcija grąžina pirmąjį reikalavimų išteklių, todėl nemanykite, kad šis atsakymas yra išsamus sąrašas. Atributų ir ryšių prieinamumas priklauso nuo šalies ir tipo; pavyzdys nėra išsami nekintama schema.

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Klaidos

  • 400: Nepavyko patikrinti šalies ir number_type: pateikite abi privalomas reikšmes. Tikrinimo pranešimo tekste gali būti formatavimo elementų.
  • 400: Invalid country ISO or No country registration documents required.: šis dviprasmiškas pranešimas savaime neįrodo, kad nuo registracijos atleidžiama.
  • 400: Invalid number type: naudokite grąžintą tipo pavadinimą. Ankstesnės versijos klaidos pranešime išvardyti Global, Local, Mobile, National, Shared Cost ir Toll Free.
  • 500: Unable to load registration requirements for the specified country and number type.: reikalavimų nepavyko sėkmingai grąžinti. Bandykite dar kartą vėliau arba kreipkitės į pagalbos tarnybą.

Prieinamumas ir šalutinis poveikis

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