Ontwikkelaars

GET/v3/get_document_number_types/{country}

Lys nommertipes vir registrasie

Vind die name van nommertipes wat tans in die registrasiekatalogus vir 'n land verteenwoordig word.

Op hierdie bladsy
  1. Kies 'n tipe volgens die naam wat teruggestuur word
  2. Groeptellings dui nie die nommervoorraad aan nie
  3. Versoek
  4. Antwoord
  5. Foute
  6. Beskikbaarheid en newe-effekte

Kies 'n tipe volgens die naam wat teruggestuur word

Gebruik 'n land uit get_document_countries. Gee die teruggestuurde tipenaam deur aan get_requirements. 'n Tipekatalogus-ID is nie 'n voorvoegsel-ID, nommer-ID of bewyskategorie-ID nie.

Groeptellings dui nie die nommervoorraad aan nie

available_groups tel die groeprekords wat deur hierdie katalogusnavraag teruggestuur word. Dit tel nie telefoonnommers wat gekoop kan word nie, reserveer geen voorraad nie en waarborg ook nie dat die katalogus alle bladsye by die stroomopbron deurgegaan het nie. Deursoek die betrokke nommervoorraad en gaan 'n kwotasie afsonderlik na.

Versoek

Gebruik jou geaktiveerde API-rekening se aanmeldbesonderhede oor HTTPS. Basic-verifikasie en geaktiveerde bearer-tokens vir API-rekeninge word ondersteun; rekeningbeperkings geld.

GET met enige gedokumenteerde parameter in die URL-pad.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Padparameters
NaamTipeVereisBeskrywing
countrystringJaTweeletter-ISO-landkode uit die katalogus van registrasielande. Witspasie aan die begin en einde word verwyder en die kode word na hoofletters omgeskakel.

Antwoord

Kontroleer status.code in die JSON-liggaam sowel as die HTTP-status. response is 'n skikking wat id, name en available_groups bevat. Gebruik name as number_type wanneer jy get_requirements aanroep; moenie id in die plek daarvan stuur nie. available_groups is die aantal groeprekords wat vir daardie tipe teruggestuur word, nie 'n telling van die telefoonnommervoorraad of 'n volledige totaal oor alle bladsye nie. Tipes waarvoor geen groepe teruggestuur word nie, word weggelaat. Die voorkeurvolgorde is Local, Mobile, National, Toll Free, Shared Cost, Global, gevolg deur ander katalogusname.

Voorbeeld van die antwoordstruktuur; nie lewendige rekeningdata of 'n huidige kwotasie nie.

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

Foute

  • 400: country is required: verskaf die ISO-kode van die registrasieland.
  • 400: Invalid country ISO or no available DID registration country found: kies 'n land uit die huidige registrasiekatalogus; dit bevestig nie dat geen dokumente vereis word nie.

Beskikbaarheid en newe-effekte

  • Hierdie navraag oor die katalogus of vereistes skep nie 'n identiteit nie, laai nie 'n bewys op nie, registreer nie 'n nommer nie en plaas nie 'n bestelling nie.
  • 'n Suksesvolle katalogusantwoord is nie goedkeuring van jou dokumente of bevestiging dat 'n gekose nommer geaktiveer kan word nie.