Listování SMS
Toto API slouží k listování SMS.
Základní popis a tvar API volání a odpovědi najdete popsané samostatně.
Služba
API patří do služby SMS (sms).
Parametry volání API
Volání musí obsahovat všechny základní parametry.
- CTRL
-
Pevná hodnota: sms_list
- from
-
Datum, od kterého se mají listovat SMS (včetně), ve formátu rrrr-mm-dd, nebo rrrr-mm-dd hh:nn:ss.
Není-li parametr zadán, listují se SMS od počátku.
- to
-
Datum, do kterého se mají listovat SMS (včetně), ve formátu rrrr-mm-dd, nebo rrrr-mm-dd hh:nn:ss.
Není-li parametr zadán, listují se SMS do času volání API (čas není shora omezen).
- start
-
Počátek listování (první SMS má index 0).
Není-li parametr zadán, výchozí hodnota je 0.
- count
-
Počet vylistovaných SMS.
Není-li parametr zadán, listují se všechny SMS odpovídající ostatním parametrům.
Příklady volání API
$login = 'user'; $call = microtime(true); $password = md5(md5("heslo").$call); $url = "https://api.profisms.cz/index.php?" . http_build_query(array( "CTRL" => "sms_list", "_login" => $login, "_password" => $password, "_service" => "sms", "_call" => $call, "from" => '2011-01-01', "to" => '2011-01-13', "count" => 2, "start" => 2, )); /** URL bude vypadat https://api.profisms.cz/index.php?CTRL=sms_list&_login=user &_password=88b61ac52efaf4ca17ede9d1e0a30a38 &_service=sms&_call=1294886598.4164&from=2011-01-01 &to=2011-01-13&count=2&start=2 */ $json = join("", file($url));
Odpověď na úspěšný požadavek na API
Základní formát odpovědi naleznete v obecném popisu API.
Popis pole data
Pole data obsahuje seznam unikátních identifikátorů.
Ukázky požadavků a odpovědí
$login = 'user'; $call = microtime(true); $password = md5(md5("heslo").$call); $url = "https://api.profisms.cz/index.php?" . http_build_query(array( "CTRL" => "sms_list", "_login" => $login, "_password" => $password, "_service" => "sms", "_call" => $call, "from" => '2011-01-01', "to" => '2011-01-13', "count" => 2, "start" => 2, ));
{ "error": { "code":0, "message":"OK" }, "data": [ "2689612", "2709365" ], "_key":"ab2063832062b63434a93f091e16df2b", "_time":0.229101896286 }
Chyba požadavku
Základní formát odpovědi naleznete v obecném popisu API.