Filloni këtu kërkimin e numrave lokalë. Lista përmban vetëm shtetet që aktualisht kanë numra në stok. Ky veprim nuk rezervon asgjë.
- Kalojeni
isocodetegetareas, tegetstates(vetëm për US dhe CA) ose teother. next_functiondrejton gjithmonë tev3/getareas/{isocode}. Për Shtetet e Bashkuara dhe Kanadanë, mund të thërrisnigetstatesfillimisht për t'i kufizuar rezultatet sipas shtetit ose provincës.is_mobiledhesms_coveragejanë tregues në nivel shteti, jo garanci për çdo numër. Për Shtetet e Bashkuara,is_mobileështë0përveç rastit kur llogaria juaj është aktivizuar për numra celularë të SHBA-së.- Shtetet me mbulim që ofrohet vetëm me porosi nuk përfshihen në listë. Megjithatë, mund të thërrisni
getareasoseotherdrejtpërdrejt për një shtet që nuk përfshihet në listë. - Renditeni vetë listën nëse ju nevojitet një renditje e caktuar.
Nëse asnjë shtet nuk i plotëson kushtet, response është null dhe status.code është 200.
Kërkesa
Kërkohet: autentikim HTTP Basic ose token Bearer (shihni Autentikimi dhe përgjigjet e API-së). Nëse autentikimi dështon, kthehet përgjigjja HTTP 401 përpara se të kryhet kërkimi.
GET pa trup kërkese. Parametri i vetëm është pid, i cili është opsional dhe dërgohet në vargun e parametrave të URL-së.
curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'| Emri | Tipi | I detyrueshëm | Përshkrimi |
|---|---|---|---|
pid | string | Jo | Parametër i avancuar dhe opsional. E kufizon listën te shtetet e shënuara për një burim inventari. Përdorni vetëm një vlerë të dhënë nga MultiTEL, në formë numerike ose heksadecimale me 32 karaktere, dhe mos e përfshini për përdorim të zakonshëm. pid nuk e kufizon kontrollin e stokut të përshkruar te përgjigjja. Vlerat e panjohura, zeroja dhe vlerat që kjo pikë fundore nuk i pranon shpërfillen pa kthyer gabim; në këtë rast, lista mbulon të gjitha burimet e mbështetura. |
Përgjigjja
Struktura standarde mbështjellëse. Kur kërkesa përfundon me sukses, status.code është 200, status.msg është 'Results: N', status.results është N dhe response është një listë shtetesh pa renditje të garantuar. Fushat: countrycode (kodi telefonik i shtetit pa '+'); name (emri i shtetit); description (e njëjta vlerë si name); isocode (kodi ISO 3166-1 alpha-2); is_mobile (0 ose 1, një tregues i katalogut në nivel shteti, gjithmonë 0 për US, përveç rastit kur llogaria juaj është aktivizuar për numra celularë të US); sms_coverage (0 ose 1, një tregues i katalogut në nivel shteti); latitude dhe longitude (koordinatat e shtetit); next_function ('v3/getareas/{isocode}'). Një shtet përfshihet në listë vetëm nëse është i dukshëm dhe të paktën një nga prefikset e tij aktualisht ka numra në stok në të paktën një burim inventari. Shtetet mbulimi i të cilave ofrohet tërësisht vetëm me porosi (pa stok) nuk përfshihen në listë. Ky kontroll i stokut është më i gjerë se filtrat që zbaton getareas, ndaj për një shtet të përfshirë në listë mund të kthehet herë pas here përgjigjja 'No areas found' atje. Nëse asnjë shtet nuk i plotëson kushtet, status.code është 200, status.msg është 'Results: 0', fusha status.results mungon dhe response është null.
Strukturë ilustruese e përgjigjes; nuk përmban të dhëna të drejtpërdrejta të llogarisë dhe nuk përbën një ofertë çmimi aktuale.
{
"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"
}
]
}Gabimet
- 401: Autentikimi mungon ose ka dështuar. Dërgohet me statusin HTTP 401 (shihni Autentikimi dhe përgjigjet e API-së).
Disponueshmëria dhe efektet anësore
- Vetëm kërkim. Nuk rezervon, nuk porosit dhe nuk ndryshon asgjë.
- Rezultatet pasqyrojnë stokun në çastin e kërkesës dhe mund të ndryshojnë nga një thirrje në tjetrën.