აშშ-ის შტატების ან კანადის პროვინციების სია, სადაც ნომრები მარაგშია

შეერთებული შტატების ან კანადის შემთხვევაში გამოიყენეთ ეს არასავალდებულო ნაბიჯი, რათა ძიება შტატით ან პროვინციით შეზღუდოთ. მიიღება მხოლოდ US და CA.

• თითოეული ჩანაწერი აღწერს მოცემული შტატის იმ პრეფიქსებს, რომელთათვისაც მოთხოვნის მომენტში მარაგი არსებობს.
• გადადით ბმულზე next_function, რათა მიიღოთ შტატის ზონების სია. მასში უკვე ჩართულია ფილტრი state, თუმცა არ არის ჩართული pid.
• ზონების ძიებისას შტატის მონაცემების შესატყვისობა ოდნავ განსხვავებულად განისაზღვრება. თუ შტატისთვის next_function აბრუნებს პასუხს No areas found, მის ნაცვლად გამოიძახეთ getareas შტატის მითითების გარეშე.
• შეამოწმეთ status.code და მხოლოდ ამის შემდეგ წაიკითხეთ response. მხარდაჭერის არმქონე ქვეყნისთვის ან ქვეყნისთვის, რომლის შესაბამისი მარაგიც არ არსებობს, ბრუნდება კოდი 404 შესაბამისი HTTP სტატუსის გარეშე.
• ცარიელი სია კოდით 200 ნიშნავს, რომ მარაგი არსებობს, თუმცა მას შტატის მონაცემები არ ახლავს. გამოიძახეთ getareas შტატის მითითების გარეშე.

მოთხოვნა

აუცილებელია: HTTP Basic ავთენტიფიკაცია ან Bearer ტოკენი (იხილეთ „ავთენტიფიკაცია და API-ის პასუხები“). წარუმატებელი ავთენტიფიკაციისას პასუხად ბრუნდება HTTP 401, ძიების შესრულებამდე.

GET მოთხოვნა ბილიკში მითითებული isocode პარამეტრით. თუ ბილიკის ეს სეგმენტი გამოტოვებულია, მის ნაცვლად იკითხება ფორმის კოდირებით გადაცემული isocode ველი. არასავალდებულო pid იგზავნება მოთხოვნის პარამეტრების სტრიქონში.

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

პასუხი

პასუხის სტანდარტული გარსი. წარმატებისას status.code არის 200, status.msg ცარიელია, ხოლო status.results ჩანაწერების რაოდენობას მიუთითებს. response არის სია, რომელიც დალაგებულია ჯერ name ველის მიხედვით (ასოების რეგისტრის გაუთვალისწინებლად), შემდეგ კი state კოდის მიხედვით. ველები: state (შტატის ან პროვინციის კოდი პრეფიქსების შტატის მონაცემებიდან, ჩვეულებრივ ორი ასო; არატიპური მნიშვნელობები უცვლელად გადაეცემა); name (კატალოგში მითითებული დასახელება, ან კოდი, თუ კატალოგში მისი დასახელება არ არის); country_iso; available (დათვლილი პრეფიქსების მარაგის საერთო რაოდენობა, ყოველთვის 0-ზე მეტი); prefix_count (დათვლილი მარაგიანი პრეფიქსების რაოდენობა); is_mobile (1, თუ რომელიმე დათვლილ პრეფიქსს მობილური კავშირის მხარდაჭერა აქვს; US ქვეყნისთვის ყოველთვის 0, გარდა შემთხვევისა, როცა თქვენს ანგარიშზე აშშ-ის მობილური ნომრები ჩართულია); sms_coverage (1, თუ რომელიმე დათვლილ პრეფიქსს SMS დაფარვა აქვს); returns_numbers (1, თუ რომელიმე დათვლილ პრეფიქსს ნომრების დაბრუნების ალამი აქვს ან ამ ალმის მნიშვნელობა არ არის მითითებული); next_function ('v3/getareas/{isocode}?state={state}'). თუ მარაგიანი პრეფიქსები არსებობს, მაგრამ არცერთს არ ახლავს შტატის მონაცემები, შედეგია status.code მნიშვნელობით 200, ცარიელი სიით და status.results მნიშვნელობით 0.

პასუხის სტრუქტურის საილუსტრაციო მაგალითი; ეს არ არის ანგარიშის მიმდინარე მონაცემები ან მოქმედი ფასის შეთავაზება.

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

შეცდომები

• 500: msg 'ISO Code parameter is required': isocode არ არის მითითებული ან ცარიელია. ეს მოთხოვნის გამოსწორებადი შეცდომაა. შესაბამისი HTTP სტატუსი არ დგინდება; წაიკითხეთ status.code.
• 404: msg 'getstates is only available for US and CA': ქვეყნის ნებისმიერი სხვა კოდი. შესაბამისი HTTP სტატუსი არ დგინდება.
• 404: msg 'No states found': ქვეყნისა და წყაროს ფილტრებს არცერთი მარაგიანი პრეფიქსი არ შეესაბამება. შესაბამისი HTTP სტატუსი არ დგინდება.
• 401: ავთენტიფიკაცია არ არის წარმოდგენილი ან წარუმატებელია. იგზავნება HTTP სტატუსით 401.

ხელმისაწვდომობა და თანმხლები მოქმედებები

• მხოლოდ ძიება. არაფერს ჯავშნის, უკვეთავს ან ცვლის. available საინფორმაციო ველია და ნომრებს არ ჯავშნის.