ადგილობრივი ნომრების მოძიება აქ დაიწყეთ. სიაში მხოლოდ ის ქვეყნებია, რომლებსაც ამჟამად მარაგში აქვთ ნომრები. ეს მოქმედება არაფერს ჯავშნის.
- გადაეცით
isocodeშემდეგ ფუნქციას:getareas, ან ფუნქციასgetstates(მხოლოდ US და CA), ან ფუნქციასother. next_functionყოველთვის მიუთითებს მისამართზეv3/getareas/{isocode}. შეერთებული შტატებისა და კანადისთვის შეგიძლიათ ჯერ გამოიძახოთgetstates, რათა ძიება შტატით ან პროვინციით შეზღუდოთ.is_mobileდაsms_coverageქვეყნის დონის მაჩვენებლებია და თითოეული ნომრისთვის გარანტიას არ იძლევა. შეერთებული შტატებისთვისis_mobileუდრის0, თუ თქვენს ანგარიშზე აშშ-ის მობილური ნომრების გამოყენება ჩართული არ არის.- ქვეყნები, სადაც დაფარვა მხოლოდ შეკვეთითაა ხელმისაწვდომი, სიაში არ შედის. სიაში არმყოფი ქვეყნისთვისაც შეგიძლიათ გამოიძახოთ
getareasანotherუშუალოდ. - თუ კონკრეტული თანმიმდევრობა გჭირდებათ, სია თავად დაალაგეთ.
თუ პირობებს არცერთი ქვეყანა არ აკმაყოფილებს, response უდრის null და status.code უდრის 200.
მოთხოვნა
აუცილებელია: HTTP Basic ავთენტიფიკაცია ან Bearer ტოკენი (იხილეთ „ავთენტიფიკაცია და API-ის პასუხები“). ავთენტიფიკაციის წარუმატებლობისას, ძიების დაწყებამდე ბრუნდება HTTP 401 პასუხი.
GET მოთხოვნა სხეულის გარეშე. ერთადერთი პარამეტრია არასავალდებულო pid, რომელიც URL-ის მოთხოვნის სტრიქონში იგზავნება.
curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'| სახელი | ტიპი | სავალდებულო | აღწერა |
|---|---|---|---|
pid | string | არა | გაფართოებული და არასავალდებულო პარამეტრია. სიას ზღუდავს იმ ქვეყნებით, რომლებიც მარაგის ერთი წყაროსთვისაა მონიშნული. გამოიყენეთ მხოლოდ MultiTEL-ის მიერ მოწოდებული მნიშვნელობა, რიცხვითი ან 32-სიმბოლოიანი თექვსმეტობითი ფორმით; ჩვეულებრივი გამოყენებისას პარამეტრი გამოტოვეთ. pid არ ზღუდავს პასუხის აღწერაში მითითებულ მარაგის შემოწმებას. ამოუცნობი მნიშვნელობები, ნული და ამ ენდპოინტისთვის მიუღებელი მნიშვნელობები უგულებელყოფილია შეცდომის გარეშე; ასეთ შემთხვევაში სია მოიცავს ყველა მხარდაჭერილ წყაროს. |
პასუხი
პასუხის სტანდარტული გარსი. წარმატების შემთხვევაში status.code უდრის 200, status.msg უდრის 'Results: N', status.results უდრის N, ხოლო response არის ქვეყნების სია, რომლის თანმიმდევრობა გარანტირებული არ არის. ველები: countrycode (ქვეყნის სატელეფონო კოდი '+' ნიშნის გარეშე); name (ქვეყნის სახელი); description (იგივე მნიშვნელობა, რაც name ველს აქვს); isocode (ISO 3166-1 alpha-2 კოდი); is_mobile (0 ან 1, კატალოგის მაჩვენებელი ქვეყნის დონეზე; US ქვეყნისთვის ყოველთვის 0, თუ თქვენს ანგარიშზე US ქვეყნის მობილური ნომრების გამოყენება ჩართული არ არის); sms_coverage (0 ან 1, კატალოგის მაჩვენებელი ქვეყნის დონეზე); latitude და longitude (ქვეყნის კოორდინატები); next_function ('v3/getareas/{isocode}'). ქვეყანა სიაში მხოლოდ მაშინ შედის, თუ ის ხილულია და მის სულ მცირე ერთ პრეფიქსს ამჟამად მარაგი აქვს მარაგის რომელიმე წყაროში. ქვეყნები, რომელთა დაფარვა მთლიანად მხოლოდ შეკვეთითაა ხელმისაწვდომი (მარაგის გარეშე), სიაში არ შედის. მარაგის ეს შემოწმება უფრო ფართოა, ვიდრე ფილტრები, რომლებსაც getareas იყენებს, ამიტომ სიაში შესული ქვეყნისთვის იქ ზოგჯერ შეიძლება დაბრუნდეს 'No areas found'. თუ პირობებს არცერთი ქვეყანა არ აკმაყოფილებს, status.code უდრის 200, status.msg უდრის 'Results: 0', status.results ველი არ არის წარმოდგენილი, ხოლო response უდრის null.
პასუხის სტრუქტურა მოცემულია საილუსტრაციოდ; ეს არ არის ანგარიშის რეალური მონაცემები ან მიმდინარე ფასის შეთავაზება.
{
"status": {
"code": 200,
"msg": "Results: 2",
"results": 2
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "38.0000",
"longitude": "-97.0000",
"next_function": "v3/getareas/US"
},
{
"countrycode": "44",
"name": "United Kingdom",
"description": "United Kingdom",
"isocode": "GB",
"is_mobile": 1,
"sms_coverage": 0,
"latitude": "54.0000",
"longitude": "-2.0000",
"next_function": "v3/getareas/GB"
}
]
}შეცდომები
- 401: ავთენტიფიკაცია არ არის წარმოდგენილი ან წარუმატებელია. იგზავნება HTTP სტატუსით 401 (იხილეთ „ავთენტიფიკაცია და API-ის პასუხები“).
ხელმისაწვდომობა და გვერდითი ეფექტები
- მხოლოდ ძიებას ასრულებს. არაფერს ჯავშნის, არ უკვეთავს და არ ცვლის.
- შედეგები ასახავს მოთხოვნის მომენტში არსებულ მარაგს და გამოძახებებს შორის შეიძლება შეიცვალოს.