დეველოპერებისთვის

GET/v3/countries

კატალოგის ქვეყნების ჩამონათვალი (მოძველებული ფორმატი)

მოძველებული ენდპოინტი, რომელიც აბრუნებს ხილულ ქვეყნებს, რომლებიც დაკავშირებულია GET /v3/other/{isocode}-ის მიერ გამოყენებულ სპეციალური ნომრების კატალოგთან, {code, data} ფორმატის შიგთავსით. ის არ ამოწმებს ნომრების მარაგს. მარაგში არსებული ნომრების მქონე ქვეყნების მოსაძებნად გამოიყენეთ GET /v3/getcountries.

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

ეს მოძველებული ენდპოინტი აბრუნებს {"code", "data"} ფორმატის შიგთავსს სტანდარტული status/response გარსის ნაცვლად. ის ჩამოთვლის ხილულ ქვეყნებს, რომლებიც დაკავშირებულია სპეციალური ნომრების კატალოგთან, და არ ამოწმებს ნომრების მარაგს.

ახალი ინტეგრაციებისთვის:

  • გამოიყენეთ GET /v3/getcountries მარაგში არსებული ნომრების მქონე ქვეყნების მოსაძებნად.
  • გამოიყენეთ GET /v3/other/{isocode} იმის სანახავად, თუ რომელი ტიპის სპეციალური ნომრებია რეალურად შეთავაზებული ქვეყანაში. აქ ჩამოთვლილი ქვეყნისთვის იქ დაბრუნებული კატალოგი მაინც შეიძლება ცარიელი იყოს.

მოთხოვნა

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

GET პარამეტრებისა და შიგთავსის გარეშე.

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

პასუხი

მოძველებული ფორმატის შიგთავსი სტანდარტული გარსის გარეშე: {code: 200, data: [...]}. არ არის status ობიექტი, არც msg ან results ველი. data ჩამოთვლის ქვეყნებს გარანტირებული თანმიმდევრობის გარეშე. ველები: countrycode (სატელეფონო კოდი '+' ნიშნის გარეშე), name, description (იგივე მნიშვნელობა, რაც name ველს აქვს), isocode, latitude და longitude. არ არის is_mobile, sms_coverage ან next_function ველები. ქვეყანა ჩამონათვალში ხვდება, როდესაც ის ხილულია და დაკავშირებულია სპეციალური ნომრების კატალოგთან. მარაგი არ მოწმდება, ამიტომ ჩამოთვლილი ქვეყნისთვის ამჟამად შეიძლება არცერთი ნომერი არ იყოს ხელმისაწვდომი. თუ არცერთი ქვეყანა არ აკმაყოფილებს პირობებს, data ველის მნიშვნელობაა null.

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

{
  "code": 200,
  "data": [
    {
      "countrycode": "33",
      "name": "France",
      "description": "France",
      "isocode": "FR",
      "latitude": "46.0000",
      "longitude": "2.0000"
    }
  ]
}

შეცდომები

  • 401: ავთენტიფიკაცია არ არის მოწოდებული ან წარუმატებელია. იგზავნება HTTP status 401 კოდით სტანდარტულ status/response გარსში და არა მოძველებული ფორმატის შიგთავსში.

ხელმისაწვდომობა და გვერდითი ეფექტები

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