Овде започните претрагу локалних телефонских бројева. Списак садржи само земље које тренутно имају бројеве на залихама. Ова претрага ништа не резервише.
- Проследите
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, који се шаље у упитном низу.
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, каталошка ознака на нивоу земље, увек 0 за US осим ако је на вашем налогу омогућено коришћење мобилних бројева за 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 одговори).
Доступност и споредни ефекти
- Само претрага. Ништа се не резервише, не наручује нити мења.
- Резултати одражавају стање залиха у тренутку захтева и могу се мењати између позива.