Zhvilluesit

GET/v3/get_document_number_types/{country}

Listoni llojet e numrave për regjistrim

Gjeni emrat e llojeve të numrave që përfaqësohen aktualisht në katalogun e regjistrimit për një shtet.

Në këtë faqe
  1. Zgjidhni një lloj sipas emrit të kthyer
  2. Numri i grupeve nuk është inventari i numrave
  3. Kërkesa
  4. Përgjigjja
  5. Gabimet
  6. Disponueshmëria dhe efektet anësore

Zgjidhni një lloj sipas emrit të kthyer

Përdorni një shtet nga get_document_countries. Përcillni emrin e kthyer të llojit te get_requirements. ID-ja e një lloji në katalog nuk është ID prefiksi, ID numri apo ID e kategorisë së dokumentit dëshmues.

Numri i grupeve nuk është inventari i numrave

available_groups numëron regjistrimet e grupeve të kthyera nga ky kërkim në katalog. Ai nuk numëron numrat e telefonit që mund të blihen, nuk rezervon stok dhe nuk garanton që katalogu ka shteruar të gjitha faqet e burimit të të dhënave. Kërkoni në inventarin përkatës të numrave dhe shqyrtoni veçmas një ofertë çmimi.

Kërkesa

Përdorni kredencialet e llogarisë suaj të aktivizuar të API-së përmes HTTPS. Mbështeten autentikimi Basic dhe tokenët bearer të aktivizuar për llogarinë e API-së; zbatohen kufizimet e llogarisë.

GET me çdo parametër të dokumentuar në shtegun e URL-së.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Parametrat e shtegut
EmriLlojiI detyrueshëmPërshkrimi
countrystringPoKodi ISO me dy shkronja i shtetit nga katalogu i shteteve për regjistrim. Hapësirat në fillim dhe në fund hiqen dhe shkronjat kthehen në të mëdha.

Përgjigjja

Kontrolloni status.code në trupin JSON si edhe statusin HTTP. response është një varg që përmban id, name dhe available_groups. Përdorni name si number_type kur thërrisni get_requirements; mos dërgoni id në vend të tij. available_groups është numri i regjistrimeve të grupeve të kthyera për atë lloj, jo sasia e numrave të telefonit në stok apo totali i plotë i të gjitha faqeve. Llojet për të cilat nuk kthehen grupe nuk përfshihen. Renditja e parapëlqyer është Local, Mobile, National, Toll Free, Shared Cost, Global, të ndjekura nga emrat e tjerë të katalogut.

Strukturë ilustruese e përgjigjes; nuk përmban të dhëna të drejtpërdrejta të llogarisë apo një ofertë aktuale çmimi.

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

Gabimet

  • 400: country is required: jepni kodin ISO të shtetit për regjistrim.
  • 400: Invalid country ISO or no available DID registration country found: zgjidhni një shtet nga katalogu aktual i regjistrimit; kjo nuk vërteton se nuk kërkohen dokumente.

Disponueshmëria dhe efektet anësore

  • Ky kërkim në katalog ose për kërkesat nuk krijon një identitet, nuk ngarkon një dokument dëshmues, nuk regjistron një numër dhe nuk bën një porosi.
  • Një përgjigje e suksesshme nga katalogu nuk përbën miratim të dokumenteve tuaja apo konfirmim se një numër i zgjedhur mund të aktivizohet.