Kehittäjät

GET/v3/get_document_number_types/{country}

Listaa rekisteröitävien numeroiden tyypit

Hae numerotyyppien nimet, jotka ovat tällä hetkellä edustettuina maan rekisteröintiluettelossa.

Tällä sivulla
  1. Valitse tyyppi sen palautetun nimen perusteella
  2. Ryhmien määrät eivät kerro numerovarannosta
  3. Pyyntö
  4. Vastaus
  5. Virheet
  6. Saatavuus ja sivuvaikutukset

Valitse tyyppi sen palautetun nimen perusteella

Käytä maata, jonka palauttaa get_document_countries. Välitä palautettu tyypin nimi kutsulle get_requirements. Tyyppiluettelon tunniste ei ole etuliitteen, numeron eikä todisteluokan tunniste.

Ryhmien määrät eivät kerro numerovarannosta

available_groups laskee tämän luettelohaun palauttamat ryhmätietueet. Se ei laske ostettavissa olevia puhelinnumeroita, varaa numeroita varannosta eikä takaa, että luettelo kattaa kaikki taustalla olevan tietolähteen sivut. Hae numeroita asianmukaisesta numerovarannosta ja tarkista tarjous erikseen.

Pyyntö

Käytä käyttöön otetun API-tilisi tunnuksia HTTPS-yhteyden kautta. Tuettuja ovat Basic-todennus ja käyttöön otetut API-tilin bearer-tunnukset; tilin rajoitukset ovat voimassa.

GET-pyyntö, jossa dokumentoidut parametrit välitetään URL-polussa.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Polkuparametrit
NimiTyyppiPakollinenKuvaus
countrystringKylläKaksikirjaiminen maan ISO-koodi rekisteröintimaiden luettelosta. Sen alusta ja lopusta poistetaan tyhjemerkit, ja kirjaimet muunnetaan suuraakkosiksi.

Vastaus

Tarkista JSON-rungon status.code sekä HTTP-tilakoodi. response on taulukko, joka sisältää kentät id, name ja available_groups. Käytä kentän name arvoa parametrin number_type arvona, kun kutsut funktiota get_requirements; älä lähetä sen tilalla kentän id arvoa. available_groups on kyseiselle tyypille palautettujen ryhmätietueiden määrä, ei puhelinnumerovarannon määrä eikä kaikkien sivujen yhteenlaskettu kokonaismäärä. Tyypit, joille ei palauteta ryhmiä, jätetään pois. Ensisijainen järjestys on Local, Mobile, National, Toll Free, Shared Cost, Global, minkä jälkeen tulevat muut luettelon nimet.

Havainnollistava vastauksen rakenne; ei reaaliaikaisia tilitietoja eikä ajantasaista tarjousta.

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

Virheet

  • 400: country is required: anna rekisteröintimaan ISO-koodi.
  • 400: Invalid country ISO or no available DID registration country found: valitse maa nykyisestä rekisteröintiluettelosta; tämä ei osoita, ettei asiakirjoja tarvita.

Saatavuus ja sivuvaikutukset

  • Tämä luettelo- ja vaatimushaku ei luo henkilöllisyyttä, lataa todistetta palveluun, rekisteröi numeroa eikä tee tilausta.
  • Onnistunut luettelovastaus ei tarkoita asiakirjojesi hyväksymistä eikä vahvista, että valittu numero voidaan aktivoida.