JAV valstijų arba Kanados provincijų, kuriose yra laisvų numerių, sąrašas

Šiuo neprivalomu žingsniu galite susiaurinti paiešką Jungtinėse Amerikos Valstijose arba Kanadoje pagal valstiją arba provinciją. Priimamos tik US ir CA reikšmės.

• Kiekviename įraše aprašomi tos valstijos prefiksai, kuriems užklausos metu yra laisvų numerių.
• Naudokite next_function nuorodą valstijos vietovių sąrašui gauti. Joje jau yra state filtras, bet nėra pid.
• Ieškant vietovių, valstijos informacija sugretinama kiek kitaip. Jei valstijos next_function grąžina No areas found, vietoj to iškvieskite getareas nenurodydami valstijos.
• Patikrinkite status.code prieš skaitydami response. Jei šalis nepalaikoma arba joje nėra kriterijus atitinkančių laisvų numerių, grąžinamas kodas 404 be atitinkamo HTTP būsenos kodo.
• Tuščias sąrašas su kodu 200 reiškia, kad laisvų numerių yra, tačiau nėra valstijos informacijos. Iškvieskite getareas nenurodydami valstijos.

Užklausa

Būtina: HTTP Basic autentifikavimas arba Bearer prieigos raktas (žr. „Autentifikavimas ir API atsakymai“). Nepavykus autentifikuoti, prieš pradedant paiešką grąžinamas HTTP 401 atsakymas.

GET užklausa su isocode kelyje. Jei šis kelio segmentas praleistas, vietoj jo nuskaitomas formos koduote užkoduotas isocode laukas. Neprivalomas pid siunčiamas užklausos eilutėje.

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

Atsakymas

Standartinė atsakymo struktūra. Sėkmės atveju status.code yra 200, status.msg yra tuščias, o status.results nurodo įrašų skaičių. response yra sąrašas, surikiuotas pagal name (neskiriant didžiųjų ir mažųjų raidžių), tada pagal state kodą. Laukai: state (valstijos arba provincijos kodas iš prefiksų valstijos duomenų, paprastai sudarytas iš dviejų raidžių; neįprastos reikšmės perduodamos nepakeistos); name (pavadinimas kataloge arba kodas, jei kataloge jam nėra pavadinimo); country_iso; available (bendras laisvų numerių kiekis visuose įskaičiuotuose prefiksuose, visada didesnis už 0); prefix_count (įskaičiuotų prefiksų, kuriems yra laisvų numerių, skaičius); is_mobile (1, jei bent vienas įskaičiuotas prefiksas palaiko mobilųjį ryšį; US atveju visada 0, nebent jūsų paskyroje įjungta galimybė naudoti JAV mobiliojo ryšio numerius); sms_coverage (1, jei bent vienas įskaičiuotas prefiksas turi SMS aprėptį); returns_numbers (1, jei bent vienas įskaičiuotas prefiksas turi numerių grąžinimo požymį arba šio požymio reikšmė jam nenurodyta); next_function ('v3/getareas/{isocode}?state={state}'). Jei yra prefiksų su laisvais numeriais, tačiau nė vienas neturi valstijos informacijos, grąžinama status.code reikšmė 200 su tuščiu sąrašu ir status.results reikšme 0.

Pavyzdinė atsakymo struktūra; tai nėra aktualūs paskyros duomenys ar dabartinis kainos pasiūlymas.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

Klaidos

• 500: msg 'ISO Code parameter is required': isocode nenurodytas arba tuščias. Tai ištaisoma užklausos klaida. Atitinkamas HTTP būsenos kodas nenustatomas; skaitykite status.code.
• 404: msg 'getstates is only available for US and CA': nurodytas bet kuris kitas šalies kodas. Atitinkamas HTTP būsenos kodas nenustatomas.
• 404: msg 'No states found': nėra prefiksų su laisvais numeriais, atitinkančių šalies ir šaltinio filtrus. Atitinkamas HTTP būsenos kodas nenustatomas.
• 401: autentifikavimo duomenys nepateikti arba autentifikuoti nepavyko. Siunčiama su HTTP būsenos kodu 401.

Prieinamumas ir šalutinis poveikis

• Atliekama tik paieška. Nieko nerezervuojama, neužsakoma ir nekeičiama. available skirtas tik informacijai ir numerių nerezervuoja.