Arendajad

GET/v3/getcountries

Loetle riigid, kus on numbreid laos

Tagastab nähtavad riigid, kus vähemalt ühe numbriprefiksi all on praegu numbreid laos. Iga kirje sisaldab riigi suunakoodi, ISO-koodi, riigi taseme mobiilinumbrite ja SMS-ide tunnuseid, koordinaate ning linki next_function riigi levialadele.

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

Alusta kohalike numbrite otsimist siit. Loend sisaldab ainult riike, kus on praegu numbreid laos. See ei broneeri midagi.

  • Edasta isocode funktsioonile getareas, funktsioonile getstates (ainult US ja CA puhul) või funktsioonile other.
  • next_function viitab alati aadressile v3/getareas/{isocode}. Ameerika Ühendriikide ja Kanada puhul võid kutsuda funktsiooni getstates esmalt välja, et kitsendada valikut osariigi või provintsi järgi.
  • is_mobile ja sms_coverage on riigi taseme tunnused ega anna garantiid iga numbri kohta. Ameerika Ühendriikide puhul on is_mobile väärtus 0, välja arvatud juhul, kui sinu kontol on USA mobiilinumbrite kasutamine lubatud.
  • Riike, kus numbrid on saadaval üksnes tellimisel, loendis ei kuvata. Saad siiski kutsuda funktsiooni getareas või other otse välja ka loendis puuduva riigi jaoks.
  • Kui vajad kindlat järjestust, sordi loend ise.

Kui ükski riik tingimustele ei vasta, on response väärtus null ja status.code väärtus 200.

Päring

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

GET ilma päringu kehata. Ainus parameeter on valikuline pid, mis edastatakse päringustringis.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Päringuparameetrid
NimiTüüpKohustuslikKirjeldus
pidstringEiTäpsemaks kasutuseks ja valikuline. Piirab loendi riikidega, mis on märgitud ühe numbriinventari allika jaoks. Kasuta ainult MultiTEL-i antud väärtust arvulisel kujul või 32-märgilise kuueteistkümnendsüsteemis esitusena ning tavakasutuses jäta see ära. pid ei kitsenda vastuse kirjelduses käsitletud laoseisu kontrolli. Tundmatuid väärtusi, nulli ja väärtusi, mida see lõpp-punkt ei aktsepteeri, eiratakse veateateta; sel juhul hõlmab loend kõiki toetatud allikaid.

Vastus

Standardne vastuse ümbris. Õnnestumise korral on status.code väärtus 200, status.msg väärtus 'Results: N', status.results väärtus N ning response on riikide loend, mille järjestus pole tagatud. Väljad: countrycode (riigi suunakood ilma märgita '+'); name (riigi nimi); description (sama väärtus mis väljal name); isocode (ISO 3166-1 alpha-2 kood); is_mobile (0 või 1, riigi taseme kataloogitunnus, riigi US puhul alati 0, välja arvatud juhul, kui sinu kontol on riigi US mobiilinumbrite kasutamine lubatud); sms_coverage (0 või 1, riigi taseme kataloogitunnus); latitude ja longitude (riigi koordinaadid); next_function ('v3/getareas/{isocode}'). Riik lisatakse loendisse ainult siis, kui see on nähtav ja vähemalt ühe selle prefiksi all on praegu mõnes numbriinventari allikas numbreid laos. Riike, kus numbrid on saadaval eranditult tellimisel (laoseis puudub), loendis ei kuvata. See laoseisu kontroll on laiem kui funktsiooni getareas rakendatavad filtrid, mistõttu võib loendis oleva riigi puhul sealt aeg-ajalt tulla vastus 'No areas found'. Kui ükski riik tingimustele ei vasta, on status.code väärtus 200, status.msg väärtus 'Results: 0', väli status.results puudub ning response väärtus on null.

Vastuse struktuuri näide; see ei sisalda konto reaalajas andmeid ega kehtivat hinnapakkumist.

{
  "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"
    }
  ]
}

Vead

  • 401: autentimine puudub või ebaõnnestus. Tagastatakse HTTP olekukoodiga 401 (vt „Autentimine ja API vastused“).

Saadavus ja kõrvalmõjud

  • Ainult otsing. See ei broneeri, telli ega muuda midagi.
  • Tulemused kajastavad päringu tegemise hetke laoseisu ja võivad väljakutsete vahel muutuda.