Saadaolevate numbritega USA osariikide või Kanada provintside loend

Kasutage seda valikulist sammu Ameerika Ühendriikide või Kanada puhul, et piirata otsingut osariigi või provintsiga. Lubatud on ainult US ja CA.

• Iga kirje kirjeldab selle osariigi prefikseid, mille all on päringu tegemise hetkel numbreid saadaval.
• Kasutage linki next_function osariigi piirkondade loendi saamiseks. See sisaldab juba filtrit state, kuid ei sisalda parameetrit pid.
• Piirkondade otsingus võrreldakse osariigi andmeid veidi teisiti. Kui osariigi next_function tagastab No areas found, kutsuge selle asemel välja getareas ilma osariiki määramata.
• Kontrollige status.code enne, kui loete välja response. Toetamata riigi või sellise riigi puhul, millel pole sobivaid saadaolevaid numbreid, tagastatakse kood 404 ilma vastava HTTP olekukoodita.
• Tühi loend koodiga 200 tähendab, et numbreid on saadaval, kuid neil puuduvad osariigi andmed. Kutsuge välja getareas ilma osariiki määramata.

Päring

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

GET päring, mille tees on isocode. Kui teesegment jäetakse välja, loetakse selle asemel vormi kodeeringus saadetud välja isocode. Valikuline pid saadetakse päringustringis.

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

Vastus

Standardne vastuse ümbris. Õnnestumise korral on status.code 200, status.msg on tühi ja status.results on kirjete arv. response on loend, mis on sorditud välja name järgi (suur- ja väiketähti eristamata) ning seejärel välja state koodi järgi. Väljad: state (osariigi või provintsi kood prefiksite osariigiandmetest, tavaliselt kaks tähte; ebatavalised väärtused edastatakse muutmata kujul); name (kataloogis olev nimi või kood, kui kataloogis sellele nime pole); country_iso; available (saadaolevate numbrite koguarv kõigi arvestatud prefiksite peale, alati suurem kui 0); prefix_count (arvestatud prefiksite arv, mille all on numbreid saadaval); is_mobile (1, kui mõni arvestatud prefiks toetab mobiilinumbreid; riigikoodi US puhul alati 0, välja arvatud juhul, kui teie kontol on USA mobiilinumbrid lubatud); sms_coverage (1, kui mõnel arvestatud prefiksil on SMS-leviala); returns_numbers (1, kui mõnel arvestatud prefiksil on numbrite tagastamise lipp või selle lipu väärtus puudub); next_function ('v3/getareas/{isocode}?state={state}'). Kui leidub prefikseid, mille all on numbreid saadaval, kuid ühelgi neist pole osariigiandmeid, on tulemuseks status.code 200 koos tühja loendiga ja status.results 0.

Näitlik vastuse struktuur; need ei ole konto reaalajaandmed ega kehtiv hinnapakkumine.

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

Vead

• 500: msg 'ISO Code parameter is required': isocode puudub või on tühi. See on parandatav päringuviga. Vastavat HTTP olekukoodi ei määrata; lugege välja status.code.
• 404: msg 'getstates is only available for US and CA': mis tahes muu riigikood. Vastavat HTTP olekukoodi ei määrata.
• 404: msg 'No states found': riigi- ja allikafiltritele ei vasta ükski prefiks, mille all oleks numbreid saadaval. Vastavat HTTP olekukoodi ei määrata.
• 401: Autentimine puudub või nurjus. Saadetakse HTTP olekukoodiga 401.

Saadavus ja kõrvalmõjud

• Ainult otsing. See ei broneeri, telli ega muuda midagi. available on teavitav väli ega broneeri numbreid.