Kehittäjät

GET/v3/getcountries

Luettele maat, joissa on numeroita varastossa

Palauttaa näkyvät maat, joissa on tällä hetkellä varastossa numeroita vähintään yhdellä numeron etuliitteellä. Jokainen tietue sisältää maan suuntanumeron, ISO-koodin, maatason matkapuhelin- ja tekstiviestitunnisteet, koordinaatit sekä maan alueisiin johtavan next_function-linkin.

Tällä sivulla
  1. Pyyntö
  2. Vastaus
  3. Virheet
  4. Saatavuus ja sivuvaikutukset

Aloita paikallisten puhelinnumeroiden etsiminen tästä. Luettelo sisältää vain maat, joissa on tällä hetkellä numeroita varastossa. Se ei varaa mitään.

  • Välitä isocode kutsuun getareas, kutsuun getstates (vain US ja CA) tai kutsuun other.
  • next_function osoittaa aina reittiin v3/getareas/{isocode}. Yhdysvaltojen ja Kanadan tapauksessa voit tehdä kutsun getstates ensin rajataksesi tuloksia osavaltion tai provinssin mukaan.
  • is_mobile ja sms_coverage ovat maatason tunnisteita, eivät takuita jokaisen numeron ominaisuuksista. Yhdysvaltojen tapauksessa is_mobile on 0, ellei tilillesi ole otettu käyttöön yhdysvaltalaisia matkapuhelinnumeroita.
  • Maita, joissa numeroita on saatavilla ainoastaan tilauksesta, ei luetella. Voit silti tehdä kutsun getareas tai other suoraan maalle, jota ei ole luettelossa.
  • Lajittele luettelo itse, jos tarvitset tietyn järjestyksen.

Jos yksikään maa ei täytä ehtoja, response on null ja status.code on 200.

Pyyntö

Pakollinen: HTTP Basic -todennus tai Bearer-tunniste (katso Todennus ja API-vastaukset). Epäonnistuneeseen todennukseen vastataan HTTP 401 -tilakoodilla ennen haun suorittamista.

GET ilman runkoa. Ainoa parametri on valinnainen pid, joka lähetetään kyselymerkkijonossa.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Kyselyparametrit
NimiTyyppiPakollinenKuvaus
pidstringEiValinnainen lisäasetus. Rajaa luettelon maihin, jotka on merkitty yhdelle numerovarannon lähteelle. Käytä vain MultiTELin antamaa arvoa numeromuodossa tai 32-merkkisenä heksadesimaaliarvona ja jätä parametri pois tavallisessa käytössä. pid ei rajaa vastauksen kuvauksessa esitettyä varastotarkistusta. Tunnistamattomat arvot, nolla ja arvot, joita tämä päätepiste ei hyväksy, ohitetaan ilman virhettä; luettelo kattaa tällöin kaikki tuetut lähteet.

Vastaus

Vakiomuotoinen vastausrakenne. Kun pyyntö onnistuu, status.code on 200, status.msg on 'Results: N', status.results on N ja response on maiden luettelo, jonka järjestystä ei taata. Kentät: countrycode (maan suuntanumero ilman merkkiä '+'); name (maan nimi); description (sama arvo kuin kentässä name); isocode (ISO 3166-1 alpha-2 -koodi); is_mobile (0 tai 1, maatason luettelotunniste, aina 0 maalle US, ellei tilillesi ole otettu käyttöön maan US matkapuhelinnumeroita); sms_coverage (0 tai 1, maatason luettelotunniste); latitude ja longitude (maan koordinaatit); next_function ('v3/getareas/{isocode}'). Maa luetellaan vain, jos se on näkyvä ja vähintään yhdellä sen etuliitteistä on tällä hetkellä numeroita varastossa jossakin numerovarannon lähteessä. Maita, joissa numeroita on saatavilla pelkästään tilauksesta (ei varastoa), ei luetella. Tämä varastotarkistus on laajempi kuin kutsun getareas käyttämät suodattimet, joten luettelossa oleva maa voi joskus palauttaa siellä vastauksen 'No areas found'. Jos yksikään maa ei täytä ehtoja, status.code on 200, status.msg on 'Results: 0', kenttää status.results ei ole ja response on null.

Havainnollistava vastauksen rakenne; ei reaaliaikaisia tilitietoja eikä voimassa oleva hintatarjous.

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Virheet

  • 401: Todennus puuttuu tai epäonnistui. Lähetetään HTTP-tilakoodilla 401 (katso Todennus ja API-vastaukset).

Saatavuus ja sivuvaikutukset

  • Pelkkä haku. Se ei varaa, tilaa eikä muuta mitään.
  • Tulokset vastaavat pyyntöhetken varastotilannetta ja voivat muuttua kutsujen välillä.