Arendajad

GET/v3/countries

Kataloogi riikide loend (pärandvorming)

Pärandliides, mis tagastab nähtavad riigid, mis on seotud erinumbrite kataloogiga, mida kasutab GET /v3/other/{isocode}, vastuse sisus kujul {code, data}. See ei kontrolli numbrite saadavust. Kasutage GET /v3/getcountries, et leida riigid, kus on numbreid saadaval.

Sellel lehel
  1. Päring
  2. Vastus
  3. Vead
  4. Saadavus ja kõrvalmõjud

See pärandliides tagastab {"code", "data"} sisu tavapärase status/response ümbrise asemel. See loetleb erinumbrite kataloogiga seotud nähtavad riigid ega kontrolli numbrite saadavust.

Uute integratsioonide puhul:

  • Kasutage GET /v3/getcountries , et leida riigid, kus on numbreid saadaval.
  • Kasutage GET /v3/other/{isocode} , et näha, milliseid erinumbrite tüüpe riigis tegelikult pakutakse. Isegi kui riik on siin loetletud, võib see teine liides tagastada selle riigi kohta tühja kataloogi.

Päring

Nõutav: HTTP Basic autentimine või Bearer-pääsutõend (vt „Autentimine ja API vastused“). Autentimise ebaõnnestumisel tagastatakse enne otsingu käivitamist HTTP 401 vastus standardses ümbrises.

GET ilma parameetrite ja päringu sisuta.

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

Vastus

Pärandvormingus sisu ilma standardse ümbriseta: {code: 200, data: [...]}. Objekt status ning väljad msg ja results puuduvad. data loetleb riigid järjekorras, mis pole garanteeritud. Väljad: countrycode (riigi suunakood ilma märgita '+'), name, description (sama väärtus mis väljal name), isocode, latitude ja longitude. Väljad is_mobile, sms_coverage ja next_function puuduvad. Riik lisatakse loendisse, kui see on nähtav ja seotud erinumbrite kataloogiga. Numbrite saadavust ei kontrollita, seega ei pruugi loetletud riigis praegu ühtegi numbrit saadaval olla. Kui ükski riik tingimustele ei vasta, on data väärtus null.

Näitlik vastuse struktuur; see ei sisalda konto reaalajas andmeid ega kehtivat hinnapakkumist.

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

Vead

  • 401: Autentimine puudub või ebaõnnestus. Vastus saadetakse HTTP status koodiga 401 standardses status/response ümbrises, mitte pärandvormingus sisus.

Saadavus ja kõrvalmõjud

  • Ainult otsing. See ei broneeri, telli ega muuda midagi.