Iegūt ASV štatu vai Kanādas provinču sarakstu ar pieejamiem numuriem

Izmantojiet šo neobligāto darbību Amerikas Savienotajām Valstīm vai Kanādai, lai sašaurinātu meklēšanu pēc štata vai provinces. Tiek pieņemti tikai US un CA.

• Katrs ieraksts apraksta prefiksus, kuriem pieprasījuma brīdī attiecīgajā štatā ir pieejami numuri.
• Izmantojiet saiti next_function štata apgabalu saraksta iegūšanai. Tajā jau ir iekļauts filtrs state, bet nav iekļauts pid.
• Apgabalu meklēšanā štata informācija tiek salīdzināta nedaudz citādi. Ja štata next_function atgriež No areas found, tā vietā izsauciet getareas bez norādīta štata.
• Pārbaudiet status.code pirms lasāt response. Ja valsts netiek atbalstīta vai tai nav atbilstošu pieejamu numuru, tiek atgriezts kods 404 bez atbilstoša HTTP statusa.
• Tukšs saraksts ar kodu 200 nozīmē, ka numuri ir pieejami, taču tiem nav štata informācijas. Izsauciet getareas bez norādīta štata.

Pieprasījums

Nepieciešama HTTP Basic autentifikācija vai Bearer pilnvara (skatiet sadaļu «Autentifikācija un API atbildes»). Ja autentifikācija neizdodas, pirms meklēšanas izpildes tiek atgriezta atbilde HTTP 401.

GET pieprasījums ar isocode ceļā. Ja ceļa segments ir izlaists, tā vietā tiek nolasīts veidlapas kodējumā nosūtīts lauks isocode. Neobligātais pid tiek nosūtīts vaicājuma virknē.

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

Atbilde

Standarta atbildes struktūra. Veiksmīga pieprasījuma gadījumā status.code ir 200, status.msg ir tukšs, un status.results ir ierakstu skaits. response ir saraksts, kas sakārtots pēc name (neņemot vērā lielo un mazo burtu atšķirības), pēc tam pēc state koda. Lauki: state (štata vai provinces kods no prefiksu štata datiem, parasti divi burti; neierastas vērtības tiek nodotas tālāk nemainītas); name (nosaukums katalogā vai kods, ja katalogā tam nav nosaukuma); country_iso; available (kopējais pieejamo numuru skaits visos uzskaitītajos prefiksos, vienmēr lielāks par 0); prefix_count (uzskaitīto prefiksu skaits, kuriem ir pieejami numuri); is_mobile (1, ja kāds uzskaitītais prefikss atbalsta mobilos numurus; valstij US vienmēr 0, ja vien jūsu kontam nav iespējota ASV mobilo numuru izmantošana); sms_coverage (1, ja kādam uzskaitītajam prefiksam ir SMS pārklājums); returns_numbers (1, ja kādam uzskaitītajam prefiksam ir numuru atgriešanas karogs vai šim karogam nav vērtības); next_function ('v3/getareas/{isocode}?state={state}'). Ja ir prefiksi ar pieejamiem numuriem, bet nevienam nav štata informācijas, rezultāts ir status.code 200 ar tukšu sarakstu un status.results 0.

Ilustratīvs atbildes struktūras piemērs; tie nav reāllaika konta dati vai aktuāls cenu piedāvājums.

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

Kļūdas

• 500: msg 'ISO Code parameter is required': isocode nav norādīts vai ir tukšs. Tā ir labojama pieprasījuma kļūda. Atbilstošs HTTP statuss netiek iestatīts; lasiet status.code.
• 404: msg 'getstates is only available for US and CA': jebkurš cits valsts kods. Atbilstošs HTTP statuss netiek iestatīts.
• 404: msg 'No states found': valsts un avota filtriem neatbilst neviens prefikss ar pieejamiem numuriem. Atbilstošs HTTP statuss netiek iestatīts.
• 401: Autentifikācija nav norādīta vai nav izdevusies. Tiek nosūtīts ar HTTP statusu 401.

Pieejamība un blakusefekti

• Tikai meklēšana. Tā neko nerezervē, nepasūta un nemaina. available ir informatīvs lauks un nerezervē numurus.