SMS info
Toto API slouží k získání informací o SMS.
Základní popis a tvar API volání a odpovědi najdete popsané samostatně.
Služba
SMS info API patří do služby SMS (sms).
Parametry volání API
Volání musí obsahovat všechny základní parametry.
- CTRL
-
Pevná hodnota: sms_info
- id
- Identifikátor SMS získaný při odesílání SMS, vizte odpověď na API pro odeslání SMS.
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_info", "_login" => $login, "_password" => $password, "_service" => "sms", "_call" => $call, "id" => 146, )); /** URL bude vypadat https://api.profisms.cz/index.php?CTRL=sms&_login=user &_password=5ec91cfbcbdcdf55748400c8006debd1&_service=sms &_call=b338a71d833a9c8c4349d392d7ae1e2fb7bcb3ad4d1a519a989716.38230669 &id=146 */ $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 objektu data
Objekt data obsahuje tyto vlastnosti:
- id
-
Unikátní identifikátor SMS (nejedná o sekvenční číslo, nereprezentuje pořadí v systému ProfiSMS).
V současné době má vlastnost formát čísla, ale jedná se o řetězec, v budoucnosti se může tato vlastnost změnit na čistý řetězec.
Tento identifikátor se používá při předávání doručenek a pro dotazovaní na stav SMS.
- state
- Stav SMS.
- delivery
- Stav doručení SMS.
- type
- Typ SMS.
- msisdn
- Telefonní číslo příjemce (zformátované do mezinárodního tvaru).
- name
- Název SMS (v případě wappushe)
- text
- Text SMS.
- validity
- Počet minut, po které je SMS platná.
- queued
- Datum zařazení SMS do fronty ve formátu rrrr-mm-dd hh:nn:ss.
- delivered
- Datum doručení SMS (nastavení stavu SMS, tzn. i datum nedoručení SMS, apod.) ve formátu rrrr-mm-dd hh:nn:ss.
- part
- Pole částí SMS (vizte níže).
- partsCount
- Počet částí SMS, na které byla SMS rozdělena.
- address
- Adresa pro doručenku (na základě parametrů delivery nebo address při požadavku na odeslání).
- source
- Číslo nebo textový identifikátor odesilatele.
- account
- Unikátní číslo účtu (variabilní symbol pro běžné platby) ze kterého proběhla platba.
Popis objektů v poli part
Objekt v poli part obsahuje tyto vlastnosti:
- id
-
Unikátní identifikátor části SMS (nejedná o sekvenční číslo, nereprezentuje pořadí v systému ProfiSMS).
V současné době má vlastnost formát čísla, ale jedná se o řetězec, v budoucnosti se může tato vlastnost změnit na čistý řetězec.
Tento identifikátor se používá při předávání doručenek.
- state
- Stav části SMS.
- delivery
- Stav doručení části SMS.
- queued
- Datum zařazení části SMS do fronty ve formátu rrrr-mm-dd hh:nn:ss.
- delivered
- Datum doručení části SMS (nastavení stavu části SMS, tzn. i datum nedoručení části SMS, apod.) ve formátu rrrr-mm-dd hh:nn:ss.
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_info", "_login" => $login, "_password" => $password, "_service" => "sms", "_call" => $call, "id" => '1544185', ));
{ "error": { "code":0, "message":"OK" }, "data": { "id":"1544185", "state":"sent", "delivery":"delivered", "type":"text", "msisdn":"+420605582922", "name": "", "text": "p\u0159\u00edli\u0161 \u017elu\u0165ou\u010dk\u00fd k\u016f\u0148 \u00fap\u011bl \u010f\u00e1belsk\u00e9 ody, p\u0159\u00edli\u0161 \u017elu\u0165ou\u010dk\u00fd k\u016f\u0148 \u00fap\u011bl \u010f\u00e1belsk\u00e9 ody", "validity":5, "queued":"2010-12-28 17:54:05", "delivered":"2010-12-28 17:55:00", "part": [ { "id":"44109244", "state":"sent", "delivery":"delivered", "queued":"2010-12-28 17:54:05", "delivered":"2010-12-28 17:55:00" }, { "id":"44109245", "state":"sent", "delivery":"delivered", "queued":"2010-12-28 17:54:05", "delivered":"2010-12-28 17:55:00" } ], "address": "http:\/\/tmp.company.cz\/tmp.php", "partsCount": 2, "source":"ztestu", "account":"123456" }, "_key":"ab2063832062b63434a93f091e16df2b", "_time":0.229101896286 }
Podobně jako v případě odeslání spožděné SMS pomocí API, pokud SMS ještě nebyla odeslána, pole part bude prázdné.
{ "error": { "code":0, "message":"OK" }, "data": { "id":"1561947", "state":"inserted", "delivery":"nostate", "type":"text", "msisdn":"+420605582922", "name": "", "text": "p\u0159\u00edli\u0161 \u017elu\u0165ou\u010dk\u00fd k\u016f\u0148 \u00fap\u011bl \u010f\u00e1belsk\u00e9 ody, p\u0159\u00edli\u0161 \u017elu\u0165ou\u010dk\u00fd k\u016f\u0148 \u00fap\u011bl \u010f\u00e1belsk\u00e9 ody", "validity":5, "queued":"", "delivered":"", "part":[], "address": "http:\/\/tmp.company.cz\/tmp.php", "partsCount": 2, "source":"ztestu", "account":"" }, "_key":"5f848e3b6876d1df0800ad6dced92633", "_time":0.0822818279266 }
Odpověď na neúspěšný požadavek na API
Chyba ID
Uživatel se smí dotazovat pouze na SMS, které sám odeslal. V případě dotazu na SMS, která mu nepatří, nebo která neexistuje, je vrácen objekt, který syntaxí odpovídá odpovědi na správný požadavek, pouze je tento objekt prázdný (vlastnost id je nulová).
{ "error": { "code":0, "message":"OK" }, "data": { "msisdn":"", "id":0, "state":"queued", "delivery":"nostate", "queued":"", "delivered":"", "part":[], "address": "", "partsCount": 0 }, "_key":"6248cfb5d0c42b8da78b062b0dae9053", "_time":0.0802619457245 }
Chyba požadavku
Základní formát odpovědi naleznete v obecném popisu API.