Kehittäjät

GET/v3/countries

Luettelon maiden listaaminen (vanha muoto)

Vanha päätepiste, joka palauttaa näkyvissä olevat maat, jotka on liitetty päätepisteen GET /v3/other/{isocode} käyttämään erikoisnumeroiden luetteloon. Vastauksen runko on muodossa {code, data}. Päätepiste ei tarkista varastotilannetta. Käytä päätepistettä GET /v3/getcountries löytääksesi maat, joissa on numeroita varastossa.

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

Tämä vanha päätepiste palauttaa {"code", "data"}-rungon tavanomaisen status/response-vastauskääreen sijaan. Se listaa näkyvissä olevat maat, jotka on liitetty erikoisnumeroiden luetteloon, eikä tarkista varastotilannetta.

Uusia integraatioita varten:

  • Käytä päätepistettä GET /v3/getcountries löytääksesi maat, joissa on numeroita varastossa.
  • Käytä päätepistettä GET /v3/other/{isocode} nähdäksesi, mitä erikoisnumerotyyppejä maassa todella tarjotaan. Tässä listatun maan kohdalla kyseinen päätepiste voi silti palauttaa tyhjän luettelon.

Pyyntö

Vaaditaan: HTTP Basic -todennus tai Bearer-tunniste (katso Todennus ja API-vastaukset). Jos todennus epäonnistuu, palautetaan HTTP 401 tavanomaisessa vastauskääreessä ennen haun suorittamista.

GET ilman parametreja ja ilman pyynnön runkoa.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/countries'

Vastaus

Vanhanmuotoinen runko ilman tavanomaista vastauskäärettä: {code: 200, data: [...]}. Vastauksessa ei ole objektia status eikä kenttiä msg tai results. data listaa maat ilman taattua järjestystä. Kentät: countrycode (maan suuntanumero ilman '+'-merkkiä), name, description (sama arvo kuin kentässä name), isocode, latitude ja longitude. Kenttiä is_mobile, sms_coverage tai next_function ei ole. Maa listataan, kun se on näkyvissä ja liitetty erikoisnumeroiden luetteloon. Varastotilannetta ei tarkisteta, joten listatussa maassa ei välttämättä ole tällä hetkellä yhtään numeroa saatavilla. Jos yksikään maa ei täytä ehtoja, kentän data arvo on null.

Havainnollistava esimerkki vastauksen rakenteesta; ei reaaliaikaisia tilitietoja eikä ajantasainen hintatarjous.

{
  "code": 200,
  "data": [
    {
      "countrycode": "33",
      "name": "France",
      "description": "France",
      "isocode": "FR",
      "latitude": "46.0000",
      "longitude": "2.0000"
    }
  ]
}

Virheet

  • 401: Todennus puuttuu tai epäonnistui. Lähetetään HTTP-tilakoodilla (status) 401 tavanomaisessa status/response-vastauskääreessä, ei vanhanmuotoisessa rungossa.

Saatavuus ja sivuvaikutukset

  • Vain haku. Se ei varaa, tilaa eikä muuta mitään.