API - REST      HTTP(S)     POST / GET, XML-RPC

 

Ak máte internetový obchod alebo akýkoľvek heterogénny systém, môžete sa na nás pripojiť. Používame štandard XML.

 

Pre ľahšiu implentáciu sme Vám pripravili dokumentáciu API (Application Programming Interface) s príkladmi.

 

Stiahnite si PHP klienta

 

https://github.com/stromaler/123sms.biz

 

pre prepojenie an desktopové aplikácie WINDOWS využite konektor

 

http://medsoftsro.cz/esmsky/

 

 

- POPIS PARAMETROV PRE POSIELANIE SMS - popis povinných a nepovinných parametrov, znakové sady a dĺžka SMS

- ODOSLANIE JEDNEJ SMS - HTTP GET/POST SMS 1 - 1071 znakov

- ODOSLANIE HROMADNEJ SMS do 1000 ks - rýchlosť prijatia 10 SMS/sec nad 1000 SMS použite XMLRPC hromadnú SMS

- ODOSLANIE HROMADNEJ SMS od 1000 do 100 000 ks - XML, SMS 1 - 459 znakov, rýchlosť prijatia 100 SMS/s.

- PRIJATIE DORUČENKY Nastavenie callbacku PUSH, stavové kódy, PULL - HTTP GET/POST, XML service načítanie po 100 záznamov.

- ZISTENIE KREDITU Zistenie zostávajúceho kreditu.

- OVERENIE TELEFÓNNEHO ČÍSLA Overovanie jedného čísla alebo dávkový príkaz pre overenie viacerých mobilných čísiel.

- NASTAVENIA ODOSIELATEĽA Odoslanie žiadosti pre nového odosielateľa, načítanie schválených odosielateľov

- SPRÁVA KONTAKTOV Administrácia kontaktov, ich priradenie ku skupinám, udalostiam a ich načítanie z SMS brány.

- SPRÁVA SKUPÍN Administrácia skupín v SMS bráne

- ZRUŠENIE ČASOVANEJ SMS A ESKALÁCIE Možnosť zrušenia načasovanej SMS alebo preposielania zlyhanej SMS cez alternatívnu trasu.

- AUTOMATICKÁ SMS Nastavenie automatickej SMS pre meniny, narodeniny a opakovaným udalostiam

- TRANSFER KREDITU MEDZI ÚČTAMI V SMS BRÁNE Možnosť prevádzania kreditu medzi účtami a podúčtami v SMS bráne

- DOBITIE SMS KREDITU KUPÓNOM Služba určená pre partnerov. Kupóny (10 miestne kódy) s rôznou hodnotou.

- OBJEDNÁVKA SMS KREDITU Možnosť objednania SMS kreditu cez API, využiteľné pre partnerské aplikácie tretích strán

- REGISTRÁCIA DO SMS BRÁNY Registrácia do SMS brány pre partnerov.

 

KONEKTORY pre Ecommerce systémy

 

Stiahnite si konektor pre Váš Ecommerce systém kliknutím na logo. Súbor rozbalte.

V menu SMS brány zvoľte SMS NÁSTROJE / ECOMMERCE SMS / Váš ECOMMERCE systém

Skopírujte hodnotu ecommerce key a vložte do súboru key.php, ktorý sa nachádza v

adresári 123sms po rozbalení .zip súbora konektora nahradte hodnotu 123456789.

Adresár 123sms nahrajte cez ftp do koreňového adreára vášho Ecommerce systému.

V NÁSTROJE / ECOMMERCE SMS / stlačte načítať XML - zobrazí objednávky

s telefónnymi číslami a menami + ID objednávok. Označte vybraté objednávky a

pošlite hromadnú SMS z konceptov.

 

 

               

 

 

 


1. Odoslanie SMS

 

API URL HTTP GET/POST : http(s)://www.123sms.sk/api/rest/

 

API URL HTTP XML POST : http(s)://www.123sms.sk/api/sms-xml/

 

API URL HTTP XMLRPC POST : http(s)://www.123sms.sk/api/sms-xml-rpc/

 

parametre pre HTTP GET/POST posielajte $parameter = rawurlencode($parameter);

 

1.1 PARAMETRE pre HTTP POST alebo HTTP GET


POVINNÉ PARAMETRE

username - prihlasovacie meno
password- heslo alebo API kľúč (API kľúč si vygenerujete v administrácii SMS brány - SMS NÁSTROJE / GENEROVAŤ API KĽÚČ)
recipient- číslo príjemcu
message- text SMS
sender - odosielateľ - max. 11 znakov, ak je alfanumerický. Ak je numerický max. 14 znakov.


NEPOVINNÉ PARAMETRE

gateway – trasa SMS (možnosť voľby trasy)

unicode – hodnota 1 SMS s diakritikou

flash – hodnota 1 pre FLASH SMS - len Premium trasa

schedule - časovaná SMS príklad hodnoty: 2012-12-31 23:59:00

Konverzia z unixového času timestamp v PHP $schedule = date("Y-m-d H:i:s", $timestamp);

escalate - hodnota v minútach

eskalácia SMS, použitie pre náročné aplikácie, ktoré vyžadujú vysokorýchlostné doručenie SMS, v prípade, že chýba doručenka do času v minútach, ktorý nastavíte, systém to zaregistruje a danú SMS prepošle cez doručovaciu trasu s najvyššou prioritou.

validity - doba platnosti SMS, nepodporuje všetky doručovacie trasy, vhodné pre použitie s eskaláciou.

egateway – trasa SMS, ktorá sa použije pre eskaláciu

evalidity– exspirácia SMS, ktorá sa použije pre eskalovanú SMS

hlr – hodnota 1 ak je poslaný parameter hlr na neexistujúce telefónne číslo, zastaví sa posielanie SMS, cena sa strhne len za overenie telefónneho čísla

name – môžete pridať meno alebo ID zakazníka, objednávky. Parameter sa uloží v databáze k danej SMS a je možný aj export doručeniek k odoslaným SMS aj do Excelu alebo CSV súboru.

limit – definuje sa v sekundách napr. limit = 60. Ak je do 60 sekúnd poslaná SMS na rovnaké číslo, SMS nebude poslaná a odpoved bude -10. Neplatí pre SMS posielané cez XML-RPC

textlimit – definuje sa v sekundách napr. limit = 60. Ak je do 60 sekúnd poslaná SMS na rovnaké číslo s rovnakým textom, SMS nebude poslaná a odpoved bude -10

cid – customer id SMS definované zákazníkom - napr.ID objednávky

callback – nastavenie vlastnej URL, na ktorú bude zaslaný status stave SMS. Ak je zadaná callback URL v SMS bráne, prepíše sa. Parameter callback ma vyššiu prioritu ako callback URL zadaná v administrácii SMS brány - SMS NÁSTROJE / URL PRE DORUČENKY

Príklad parametru callback=http://www.vasadomena.com/

lenght – dĺžka SMS, len pre hromadnú SMS posielanú cez XML-RPC API. V XML reťaci je potrebné definovať najvyšší počet znakov, ktoré môže SMS obsahovať najdlhšia SMS. Ak máte kombinované texty SMS s dlhším a kratším počtom znakov odporúčame posielať v samostaných RPC, kde si najprv vytvoríte "SORT" podla dĺžky SMS. Ak je definovaná dĺžka SMS napr. 1 a niektoré SMS v RPC majú nad 160 znakov pošle sa len prvých 160 znakov. Ak definujete stále max. dĺžku 3, SMS sa pošlú korektne aj keď má SMS dĺžku 1, avšak pri nízkom kredite odporúčame posielať po menších dávkach (počet položiek napr. 10), aby systém nevrátil odpoveď - nízky kredit.

 

Príklad HTTP GET requestu pre prijatie doručenky:

 


http://www.vasadomena.com/?msgid=13757291204063&price=0.0425&status=1&cid=123 

 


 

Viac informácii v bode 2.5 DELIVERY REPORT HTTP GET / PUSH METHOD

 

 

API 123sms automaticky odstráni diakritiku. SMS prichádzajú v kódovaní GSM 7.
Text SMS sa upraví do nasledovných povolených znakov


Napríklad: č – bude nahradené znakom c

 

 

 

pre partnerské SMS brány, ktoré zabezpečia overenie telefónneho čísla umožňujeme odosielať cez dynamického odosielateľa.

 

Možné hodnoty parametra unicode

 

0 – LATIN 7
1 - SMS je odoslaná ako utf-8 s podporou diakritiky

 

 

Možné hodnoty parametra gateway

 

basic

standard

premium

 

 

Na trase (basic) sú nastavené stále najlepšie ceny pre Slovenskú republiku.


1.2 POVOLENÉ ZNAKY pre Latin 7


\@\£\$\¥\è\é\ù\ì\ò\Ç\Ø\ø\Å\å\_\^\{\}\\[\~\]\|\Æ\æ\ß\É\!\\\"\#\¤\%\&\\\'\(\)\*\
+\,\-\.\/0123456789:;=?\!ABCDEFGHIJKLMNOPQRSTUVWXYZÄÖNܧ\abcdefghijklmnopqrstuvwxyzäönüa

 

Pre LATIN 7 je dĺžka SMS 160 znakov, pre dlhé SMS každá ďalšia 153 znakov. Viac informácii tu

 

 

ak posielate parameter unicode=1 sú povolené všetky znaky a SMS sa účtuje ako UTF SMS = max. 70 znakov, pri dlhej SMS každá ďalšia 63 znakov. UTF SMS sú posielané cez trasu PREMIUM.

 

 


1.3 ODPOVEĎ 123sms

 

i = ID SMS
s = Parameter status
s – status

 

Možné stavy parametra s

2 - SMS prijatá do systému a načasovaná ak je dátum v správnom formáte (19 znakov - príklad 2012-12-31 23:59:00)

1 - SMS prijatá do systému

0 - SMS prijatá do systému + upozornenie na nízky kredit
- 1 - Nesprávne prihlasovacie údaje
- 2 - Nedostatočný kredit
- 3 - číslo nie je aktivované
- 4 - nie je uhradená faktúra, číslo je aktivované
- 5 - Chybný príjemca

- 6 - Chybný odosielateľ
- 7 - Chýba text správy (alebo zakázaný znak € nahradte EUR)
- 8 - prekročená maximálna dĺžka SMS 1071 znakov
- 9 - zastavené posielanie cez HLR ak je chybné číslo, len ak sa posiela parameter hlr = 1
- 10 - prekročený časový limit pre parameter limit alebo textlimit

- 11 - neznáma chyba na doručovacej trase, odporúčame opakovať pokus ihneď cez alternatívnu trasu pri vysokej priorite

alebo poslať tú istú SMS po krátkom čase znovu cez rovnakú trasu

c – kredit
p - cena SMS

g - trasa , ktorú ste zvolili cez parameter g

1.4 Príklad odpovede

<?xml version="1.0" encoding="UTF-8"?>
<r>
   <i>13680479036610</i>

   <s>1</s>

   <c>74.2509</c>

   <p>0.0455</p>

   <g>basic</g>

</r>

 

1.5 Príklad odoslania SMS


HTTP GET


http://www.123sms.sk/api/rest/?username=prihlasovacie-meno&password=heslo-alebo-api-kluc&recipient=421905123456&sender=FirmaXY&message=testovacia-sms


HTTP POST


<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&recipient=$recipient&sender=$sender
&gateway=basic&message=
$smstext");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/rest/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch)){
/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else {
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
   {

   case 
200$xmlObject = new SimpleXMLElement($data);
   
$idsms $xmlObject->i/* IdSMS */
   
$status $xmlObject->s/* Status */
   
$gateway $xmlObject->g/* Doručovacia trasa */
   
$pricesms $xmlObject->p/* Cena SMS */
   
$credit $xmlObject->c/*Zostávajúci kredit */
   
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
   }
 }
curl_close($ch);
?>

 

 

 

HROMADNÁ SMS (10 SMS sec.)

 

HTTP POST

 

<?php
$numbers 
= array('421903123456''421905123456''421944123456');
if (
is_array($numbers)) 
{
foreach (
$numbers as $recipient)
{
 
$ch curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&recipient=$recipient&sender=$sender
&gateway=basic&message=
$smstext");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/rest/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) )
{
/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
    {

case 
200$xmlObject = new SimpleXMLElement($data);
$idsms $xmlObject->i/* IdSMS */
$status $xmlObject->s/* Status */
$gateway $xmlObject->g/* Doručovacia trasa */
$pricesms $xmlObject->p/* Cena SMS */
$credit $xmlObject->c/*Zostávajúci kredit */
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
}
}
curl_close($ch);
}
}

?>

 

 

 

 

HROMADNÁ SMS XML (100 SMS/s.)

 

username - prihlasovacie meno

password - heslo alebo API kľúč

sender - odosielateľ SMS

def_time - čas odoslania hromadnej SMS, ak nie je definovaný použije sa aktuálny

id - voliteľné unikátne ID generované zákazníkom, identifikácia pre doručenky metóda HTTP GET/POST - PULL / PUSH

name - voliteľné meno zákazníka, pre export doručeniek do Export do CSV, XLS

idc - voliteľné id zákazníka, pre export doručeniek do Export do CSV, XLS

send_time - čas odoslania SMS, nadradený def_time

unicode - SMS bude odoslaná s diakritkou, podporujú trasy standard a premium

phone - Telefónne číslo

text - Text SMS

gateway - definujete trasu SMS: basic, standard, premium. Ak predvolíte v administráciu SMS brány gateway standard alebo priemium bude to mať vyššiu prioritu ako definovaný parameter gateway v XML

escalate - hodnota v minútach eskalácia SMS, použitie pre náročné aplikácie, ktoré vyžadujú vysokorýchlostné doručenie SMS, v prípade, že chýba doručenka do času v minútach, ktorý nastavíte, systém to vyhodnotí a danú SMS prepošle cez doručovaciu trasu s najvyššou prioritou.

callback - na definovanú URL bude zaslaná doručenka k SMS. Nutné definovat unikátne ID správy pre následné priradenie stavu

 

<?php 
define
('XML_PAYLOAD''<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <credential>
        <username>meno</username>
        <password>heslo alebo API klúč</password>
    </credential>
      <message>
        <sender>mojafirma</sender>
        <def_time>2016-12-31 23:59:00</def_time>
        <recipients>
            <recipient>
                <id>121</id>  
                <unicode>0</unicode>
                <phone>421911123456</phone>
                <text>Text prvej SMS</text>
            </recipient>
            <recipient>
                <id>122</id>
                <send_time>2017-12-31 23:59:00</send_time>
                <unicode>1</unicode>
                <phone>421944123456</phone>
                <text>Text SMS číslo 2 s diakritikou</text>
            </recipient>
            <recipient>
                <id>123</id>
                <name>Janko Hraško</name>
                <idc>12345</idc>
                <send_time></send_time>
                <unicode>0</unicode>
                <phone>42190512346</phone>
                <text>Text tretej SMS</text>
            </recipient>
        </recipients>
    </message>
    <optional>
        <escalate>0</escalate>
        <gateway>standard</gateway>
        <callback>http://www.domena.sk/sms/callback.php</callback>
    </optional>
</sms>'
); 
define('XML_POST_URL''http://www.123sms.sk/api/sms-xml/'); 
$ch curl_init(); 
curl_setopt($chCURLOPT_URLXML_POST_URL); 
curl_setopt($chCURLOPT_RETURNTRANSFER1); 
curl_setopt($chCURLOPT_TIMEOUT60); 
curl_setopt($chCURLOPT_POSTFIELDSXML_PAYLOAD); 
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close')); 
$result curl_exec($ch); 
if (
curl_errno($ch) ) 

$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch); 

else 

$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE); 
switch(
$returnCode
   { 
   case 
200$xmlObject = new SimpleXMLElement($myXMLData);   
             
$status $xmlObject->status
             
$balance $xmlObject->balance
             
$errorsms $xmlObject->errorsms;
             
$failedsms $xmlObject->failedsms;  
   break; 
   case 
404
   
$result 'ERROR -> 404'
   break; 
   default: 
       } 

curl_close($ch); 

?> 
 

 

 

Odpoveď XML

<response>
  <status>1</status>
  <balance>64.2454</balance>
  <sentsms>3</sentsms>
  <errorsms></errorsms>
  <failedsms></failedsms>
</response>

 

status -

1 prijaté volanie

- 1 chybné prihlasovacie údaje

sentsms - počet úspešne prijatých SMS do systému

errorsms - počet neodoslaných SMS z dôvodu chybných čísiel

failedsms - počet neodoslaných SMS z dôvodu nízkeho kreditu

 

 

 

2. Doručenka SMS

 

API URL: http://www.123sms.sk/api/delivery/

API URL: http://www.123sms.sk/api/delivery-xml/ - XML service po 100 záznamov pre velké objemy SMS

2.1 PARAMETRE PRE HTTP POST


username - prihlasovacie meno
password - heslo
idsms - id SMS

 

pre hromadné SMS je potrebné volať v cykle 1. počiatočné IDsms +100 - nX najvyššie IDsms + 100 - napr. 100, 200, 300 - odpoveď XML je po 100 záznamov z databázy LIMIT 100 ORDER BY ID ASC

 

2.2 ODPOVEĎ 123sms

Parametre

 

i - ID SMS
d - dátum doručenia
s – status

 

Možné stavy parametra s


1 - Doručená

2 - Prijatá do SMSC

3 - Účastník v roamingu

4 - Zlyhaná SMS

5 - Nezaradený status

6 - Neexistujúce číslo

7 - Exspirovaná

8 - Poslaná do siete

9 - Blokovaná hovorom

10 - Zamietnutá SMSC

11 - Chýba v SMSC

12 - Blokovaný obsah SMS

13 - Čaká vo fronte

14 - Neznáma chyba

15 - Chyba v routingu

16 - Nesprávny odosielateľ

17 - Nesprávny príjemca

18 - Systémová chyba

19 - Nevalídny formát správy

20 - SPAM

2. 3 OdpoveĎ

Zlyhaná autentifikácia

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

Po úspešnom prihlásení

 

2.4 Príklad odpovede pre OVERENIE DORUČENKY

 

1 SMS

<?xml version="1.0" encoding="UTF-8"?>
<r>
    <i>123456789</i>
    <d>2011/5/25 19:20:30</d>
    <s>1</s>
</r>

 

HromadnĚ DORUČENKY XML - po 100 zÁznamov

<?xml version="1.0" encoding="UTF-8"?>
   <response>
                 <gsm>
                         <r>421903123456</r>
                        <id>1</id>
                        <s>2</s>
                        <d>11:00:19 18/07/2013</d>
                        <t>00:00:19</t>
                </gsm>
                <gsm>
                       <r>421904123456</r>
                       <id>2</id>
                       <s>2</s>
                       <d>11:00:04 18/07/2013</d>
                       <t>00:00:04</t>
                 </gsm>
                 <gsm>
                       <r>421905123456</r>
                       <id>3</id>
                       <s>1</s>
                       <d>11:01:14 18/07/2013</d>
                       <t>00:01:14</t>
                 </gsm>
                <gsm>
                       <r>421907123456</r>
                       <id>4</id>
                       <s>1</s>
                       <d>11:00:17 18/07/2013</d>
                       <t>00:00:17</t>

                 </gsm>
                <gsm>

                       <r>421908123456</r>
                       <id>5</id>
                       <s>1</s>
                       <d>11:02:07 18/07/2013</d>
                       <t>00:02:07</t>

                 </gsm>

</response>

 


2.5 PrÍklad zistenia doruČenky - HTTP POST / METÓDA PULL

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&idsms=14034669554832");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/delivery/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch)){
/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else {
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
   {
   case 
200$xmlObject = new SimpleXMLElement($data);
   
$idsms $xmlObject->i/* IdSMS */
   
$date $xmlObject->d/* Dátum */
   
$status $xmlObject->s/* Status */
   
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
   }
 }
curl_close($ch);
?>

 

 

 


2.6 PrÍklad zistenia doruČenky - HTTP POST / METÓDA PULL

 

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/credit/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch)){
/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else {
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
   {

case 
200$xmlObject = new SimpleXMLElement($data);   
foreach (
$xmlObject->gsm as $val
{
  
$recipient $val->r
  
$id$val->id;
  
$status $val->s
  
$donedate$val->d
  
$deliverytime$val->t
  }
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
   }
 }
curl_close($ch);
?>


2.5 DELIVERY REPORT HTTP GET / PUSH METHOD

Je potrebné nastaviť v našom systéme

 

Príklad HTTP GET requestu



http://www.vasadomena.com/?msgid=13757291204063&price=0.0425&status=1&cid=123 


Odpoveď Vášho servera je text plain OK. Ak nepodpovie Váš server OK, opakujeme volanie Vášho servera.
msgid = id SMS
price = cena SMS
status = status správy 
cid = id definované zákazníkom int(11)

 

 

 

Odpoveď Vášho servera je OK. Ak neodpovie server OK (text plain), náš systém opakuje volanie Vášho servera každú min po dobu 24 hod.


3. Kredit

 

API URL pre kredit: http://www.123sms.sk/api/credit/

 

 

3.1 PARAMETRE pre HTTP POST

 

username – prihlasovacie meno
password - heslo

 

3.2 ODPOVEĎ 123sms

 

Zlyhaná autentifikácia

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

Po úspešnom prihlásení


3.3 Príklad odpovede


c - výška kreditu

 

 

<?xml version="1.0" encoding="UTF-8"?>

<r>
    <c>25.5262</c>

</r>

3.4 Príklad zistenia kreditu - HTTP POST

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&amp;password=$password");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/credit/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch)){
/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else {
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
   {
   case 
200$xmlObject = new SimpleXMLElement($data);
   
$credit $xmlObject->c/* Kredit */
   
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
   }
 }
curl_close($ch);
?>

 

 

 

 

 

4. Overenie telefónneho čísla HTTP POST / GET

 

Zobrazí stále aktuálne ceny, ktoré si zvolíte na webe.


API URL:http://www.123sms.sk/api/hlr/

4. PARAMETRE PRE HTTP POST

 

username – prihlasovacie meno
password - heslo

destination - overované číslo

 

4. 1 OdpoveĎ

Zlyhaná autentifikácia

 

<r>

    <s>-1</s>
</r>

 


 

Po úspešnom overení čísla

 

4.2 Príklad odpovede

<?xml version="1.0" encoding="UTF-8"?>
<response>
            <id>31235263289322</id>
            <status>OK</status>
            <number>421944385600</number>
            <ported>false</ported>
            <pnetwork>Telefónica Slovakia</pnetwork>
            <dial>421</dial>
            <localdial>944</localdial>
            <country>Slovakia</country>
            <mccmnc>23106</mccmnc>
            <imsi>230030003015781</imsi>
            <error>0</error>
            <roamingcountry>Germany</roamingcountry>
            <roamingnetwork>Vodafone</roamingnetwork>
            <roamingdial>49</roamingdial>
            <roaminglocaldial>172</roaminglocaldial>
</response>

 

 

4.3 PrÍklad OVERENIA ČÍSLA CEZ HLR

<?php 
$ch 
curl_init() or die(curl_error());
  
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password");
  
curl_setopt($chCURLOPT_POST1);
  
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/hlr/");
  
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
  
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
 else
 {
  
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
  switch(
$returnCode)
{
  case 
200$xmlObject = new SimpleXMLElement($data);
  
$id $xmlObject->id;  /* Id */
  
$status $xmlObject->status;  /* Status , možné stavy OK - fukčné číslo a FALSE chyba*/
  
$number $xmlObject->number;  /* Overované číslo*/
  
$ported $xmlObject->ported;  /* Prenesené, hodnorta true alebo false*/
  
$pnetwork $xmlObject->pnetwork;  /*Zostávajúci kredit */
  
$dial $xmlObject->dial;  /* Predvoľba krajiny*/
  
$localdial $xmlObject->localdial;  /* Predvoľba operátora*/
  
$country $xmlObject->country;  /* Krajina*/
  
$mccmnc $xmlObject->mccmnc;  /*Identifikátor siete*/
  
$imsi $xmlObject->imsi;/*Identifikátor siete*/
  
$error $xmlObject->error/*Kód chyby*/
  
$roamingcountry $xmlObject->roamingcountry/*Krajina romaingu*/
  
$roamingnetwork $xmlObject->roamingnetwork/*Sieť roamingu*/
  
$roamingdial $xmlObject->roamingdial/*Predvoľba krajiny roamingu*/
  
$roaminglocaldial $xmlObject->roaminglocaldial/*Predvoľba operátora v roamingu*/
  
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  }
  }
  
curl_close($ch);?>

 

 

 

 

5. Hromadné overenie telefónnych čísiel XML-RPC

 

Zobrazí stále aktuálne ceny, ktoré si zvolíte na webe.


API URL:'http://www.123sms.sk/api/hlr-xml-rpc/

 

5. 1 OdpoveĎ

Zlyhaná autentifikácia

 

<?xml version="1.0" encoding="utf-8" ?>
<methodResponse>
                       <response>
                                <value>
                                        <struct>
                                                 <param>
                                                            <name>credit</name>
                                                            <value><string>0</string></value>
                                                 </param>
                                                 <param>
                                                           <name>status</name>
                                                           <value><string>-1</string></value>
                                                 </param>
                                        </struct>
                              </value>
               </response>
</methodResponse>

 


 

Po úspešnom prihlásení

 

5.2 Príklad odpovede


<?xml version="1.0" encoding="utf-8" ?>
<methodResponse>
                          <response>
                                          <value>
                                                      <struct>
                                                                  <param>
                                                                             <name>credit</name>
                                                                             <value><string>525.1250</string></value>
                                                                  </param>
                                                                  <param>
                                                                             <name>status</name>
                                                                             <value><string>1</string></value>
                                                                 </param>
                                                                 <param>
                                                                             <name>count</name>
                                                                             <value><int>850</int></value>
                                                                </param>
                                                                <param>
                                                                               <name>schedule</name>
                                                                              <value><int>5</int></value>
                                                                </param>
                                                    </struct>
                                      </value>
                       </response>
</methodResponse>

 

5.3 PrÍklad hROMADNÉHO OVERENIA ČÍSIEL

<?php 

define
('XML_PAYLOAD''<?xml version="1.0" encoding="utf-8" ?>
<methodResponse>
                <response>
                          <value>
                                  <struct>
                                           <param>
                                                   <name>username</name>
                                                    <value>user</value>
                                                         </param>
                                                                 <param>
                                                                      <name>password</name>
                                                                      <value>pass</value>
                                                           </param>
                                                           <param>
                                                                  <name>schedule</name>
                                                                  <value><string>0</string></value>
                                                           </param>
                                                           <param>
                                                                  <name>callback</name>
                                                                  <value>http://www.vasadomena.sk</value>
                                                           </param>
                                                                   <param>
                                                                          <name>datahlr</name>
                                                                                <struct>
                                                                                  <struct>
                                                                                     <value>421905123456</value>
                                                                                    <value>123</value>
                                                                                    <value>Janko</value>
                                                                                 </struct>
                                                                        <struct>
                                                                                <value>421903123456</value>
                                                                                <value>124</value>
                                                                                <value>Ferko</value>
                                                                       </struct>
                                                            </struct>
                                                   </param>
                                          </struct>
                                  </value>
                      </response>
</methodResponse>'
);
define('XML_POST_URL''http://www.123sms.sk/api/hlr-xml-rpc/');
$ch curl_init();
curl_setopt($chCURLOPT_URLXML_POST_URL);
curl_setopt($chCURLOPT_RETURNTRANSFER1);
curl_setopt($chCURLOPT_TIMEOUT60);
curl_setopt($chCURLOPT_POSTFIELDSXML_PAYLOAD);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$result curl_exec($ch);
if (
curl_errno($ch) ){
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
} else {
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode){
case 
200$phpvars xmlrpc_decode($result);
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
   }
}
}
curl_close($ch);
print_r($phpvars);?>

 

6. Nastavenie odosielateľa

 

API URL pre nastavenie nickus: http://www.123sms.sk/api/nick/

 

 

6.1 PARAMETRE pre HTTP POST

 

username – prihlasovacie meno
password - heslo

sender - odosielateľ (nick)

action - akcia

- new : žiadost o nový nick

- delete: zmazanie nicku

- show: načítanie povolených nickov (odosielateľov)

 

6.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


6.3 Príklad odpovede


n - zoznam nickov odosielateľov

s - status

zamietnuta požiadavka - 0 (napr. nick už je schválený, duplicitná požiadavka na schválenie alebo chýbajúci parameter)

odosielanie žiadosti - 1 (schvaľuje správca)

zmazanie nicku - 2

 

 

action=new

 

<?xml version="1.0" encoding="UTF-8"?>

<r>
    <s>1</s>

</r>

 

action=show

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>
    <n>Firma.sk</n>

    <n>+421903123456</n>

</r>

6.4 Príklad ZIADOSTI o NOVÝ NICK

<?php 
$ch 
curl_init() or die(curl_error());
  
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password
&action=new&sender=firma.sk"
);
  
curl_setopt($chCURLOPT_POST1);
  
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/sender/");
  
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
  
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
  
$data =curl_exec($ch);
  if (
curl_errno($ch) ){/* Chyba CURL */
  
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
  } 
else
 {
  
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
  switch(
$returnCode)
{
  case 
200$xmlObject = new SimpleXMLElement($data);
  
$status $xmlObject->s;  /*Status*/
  
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  }
  }
  
curl_close($ch);?>

 

 

 

7. Správa a načítanie kontaktov

 

API URL pre načítanie kontaktov: http://www.123sms.sk/api/contacts/

 

 

7.1 PARAMETRE pre HTTP POST

 

povinné parametre sú: username, password, action, number

 

username – prihlasovacie meno
password - heslo

recipient - telefónne číslo (zadajte v medzinárodnom tvare napr. 421903123456)

email - emailová adresa

name - názov kontaktu (napr. meno a priezvisko)

firstname - krstné meno (musí byť presne zhodné s kalendárnym pre upozornenie na meniny alebo poslanie automatickej SMS)

idc - ID zakazníka

groups - kód skupiny napr. A1 pre zaradenie kontaktu do viacerých skupín napr. do troch: A1A5B4

description - popis kontaktu (max. 30 znakov)

born - dátum amesiac narodenia - napr. 17/10

byear - rok narodenia

event - popis udalosti - napr. splatnosť faktúry

date - dátum udalosti napr. 19/11/2014 (podobná funkcia ako časovaná SMS ale nie je potrebné nastaviť čas a text). SMS sa odosiela konceptu, ktorý je definovaný v SMS bráne a v čase, ktorý je nastavený pre automatickú SMS. Funkcia automatická SMS musí byť aktivovaná v SMS bráne.

mdate - opakovaná ročná mesačná udalosť. napr. 25

ydate - opakovaná ročná mesačná udalosť napr. 20/08

gender - pohlavie: 1 - muž , 2 žena

quick- zobrazenie kontaktu v adresári kontaktov v rýchlej voľbe

action - akcia

- new : pridanie nového kontaktu

- delete: zmazanie kontaktu

- edit: editácia kontaktu

- show: načítanie kontaktov (meno, telefónne číslo)

- showall: načítanie všetkých kontaktov

filter - len pri setnutom parametri action=show alebo showall

parametre len ak je hodnota filter=true

- groups - filter napr. A1A5B4 (kontakt je v 3 skupinách A1 A5 B4)

- letter - prvých 10 písmen názvu kontaktu

 


 

7.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


7.3 Príklad odpovede


n - zoznam nickov odosielateľov

s - status

zamietnuta požiadavka - 0 (napr. kontakt je už pridaný)

pridanie kontaktu - 1

chybné číslo - 2

zmazanie kontaktu - 3

kontak chýba v DB - 4

 

action=new

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>
    <s>1</s>

</r>

 

 

 

action=show

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<contacts>

               <contact>
                             <recipient>421903123546</recipient>
                             <name>Janko Hraško</name>

                </contact>

                <contact>

                             <recipient>421905123546</recipient>
                             <name>Ferko Mrkvička</name>
                </contact>

</contacts>

 

 

action=showall

 

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
   <contacts>

                <contact>

                            <idc>123456</idc>
                             <recipient>421903123546</recipient>
                             <name>Ján Novák</name>
                             <firstname>Ján</firstname>

                              <email>janko.hrasko@gmail.com</email>
                             <groups>A7</groups>
                              <description>Gaštanová ulica</description>
                             <born>12/05</born>
                             <byear>1985</byear>

                             <event>Seminár z psychológie</event>
                             <date>30/08/2012</date>
                             <mdate>21</mdate>

                             <ydate>20/09</ydate>

                            <gender1</gender>
                              <quick>1</quick>
                  </contact>

                  <contact>
               <idc>123456</idc>
                             <recipient>421905123546</recipient>
                             <name>Anna Nováková</name>
                             <firstname>Anna</firstname>

                              <email>anna.novakova@gmail.com</email>
                             <groups>A7</groups>
                              <description>Gaštanová ulica</description>
                             <born>12/05</born>
                             <byear>1985</byear>

                             <event>Preventívna prehliadka</event>
                             <date>30/08/2012</date>
                             <mdate>21</mdate>

                             <ydate>20/09</ydate>

                             <gender>2</gender>
                              <quick>1</quick>


                   </contact>

</contacts>


7.4 PrÍklad ZOBRAZENIA KONTAKTOV S FITROM PRE SKUPINU

<?php 
$ch 
curl_init() or die(curl_error());
  
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&action=filter&groups=A3");
  
curl_setopt($chCURLOPT_POST1);
  
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/contacts/");
  
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
  
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
  
$data =curl_exec($ch);
  if (
curl_errno($ch) )
{
/* Chyba CURL */
  
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
  } 
else
{
  
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
  switch(
$returnCode)
{
  case 
200:   $xmlObject = new SimpleXMLElement($data);
  foreach (
$xmlObject->contact as $val
  {
$recipient $val->recipient
$email$val->email;
$name$val->name;
$firstname $val->firstname
$idc$val->idc
$email $val->email
$groups$val->groups
$description $val->description
$born$val->born
$byear $val->byear
$event$val->event
$date $val->date
$mdate$val->mdate
$ydate $val->ydate
$gender $val->gender
$quick$val->quick
}

break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  }
}
curl_close($ch);?>

 

 

7.4 PrÍklad Pridania KONTAKTU

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&action=new&recipient=$recipient&name=$name&firstname=$firstname
&idc=
$idc&groups=$groups&description=$description&born=$born&byear=$byear
&event=
$event&date=$date&mdate=$mdate&ydate=$ydate&email=$email&quick=1");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/contacts/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
{
case 
200/* $xmlObject = new SimpleXMLElement($data);
$status = $xmlObject->s; */
echo $data;
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

 

8. Správa skupín

 

API URL pre načítanie skupín: http://www.123sms.sk/api/groups/

 

 

8.1 PARAMETRE PRE HTTP POST

 

username – prihlasovacie meno
password - heslo

gname - meno skupiny

 

action - akcia

- new : vytvorenie novej skupiny

- delete: zmazanie skupiny

- show: načítanie zoznamu skupín

 

8.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


8.3 PRÍKLAD ODPOVEDE


s - status

zamietnutá požiadavka - 0 (napr. skupina už je vytvorená alebo chýbajúci parameter, )

Vytvorenie, alebo editácia skupiny - 1

zmazanie skupiny- 2

id - skupiny pre poslanie hromadnej SMS skupine

 

action=new

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

     <n>Zakazníci</n>

     <id>A1</id>
     <s>1</s>

</r>

 

action=delete

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

     <s>2</s>

</r>

 

action=edit

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

     <s>1</s>

</r>

 

 

action=show

 

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<r>
      <g>
          <n>Zákazníci</n>

           <id>A1</id>

      </g>
      <g>

          <n>Dodávatelia</n>

           <id>A2</id>

      </g>

</r>

8.4 PRÍKLAD VYTVORENIA NOVEJ SKUPINY

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&action=new&group=zakaznici");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/groups/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> 'curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
      {
case 
200$xmlObject = new SimpleXMLElement($data);
break;
      case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

PRÍKLAD pre zobrazenie skupín a načítanie XML

 

 

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&action=show");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/groups/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
      {

case 
200$xmlObject = new SimpleXMLElement($data);
foreach (
$xmlObject->as $val
{
$name $val->n
$idgroup $val->id;
     }
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

9. Zmazanie časovanej SMS alebo zrušenie eskalovanej SMS

 

API URL pre zmazanie časovanej SMS alebo zrušenie automatickeho preposlania SMS (pozri parameter escalate),

v pripade zistenia, ze je cislo na ktore nebolo doručena SMS je nesprávne.

 

http://www.123sms.sk/api/schedule/

 

 

9.1 PARAMETRE PRE HTTP POST

 

username – prihlasovacie meno
password - heslo

idsms - idsms

action - timed

           - escalate


 

9.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


9.3 PRÍKLAD ODPOVEDE


s - status

zamietnutá požiadavka - 0 (IDsms sa nenašlo v databáze)

úspešne zmazanie časovanej SMS - 1

 

Zmazanie časovanej SMS 

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>1</s>
</r>

 


9.4 PRÍKLAD ZMAZANIA ČASOVANEJ SMS

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&idsms=$idsms&action=timed");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/schedule/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
{
case 
200/* $xmlObject = new SimpleXMLElement($data);
$status = $xmlObject->s; */
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

 

10. Nastavenie automatickej SMS

 

API URL pre automatickú SMS: http://www.123sms.sk/api/autosms/

 

 

SMS sa načasujú každý deň 00:00 na definovaný čas, ktorý je pridelený k jednotlivým typom automatických SMS.

10.1 PARAMETRE PRE HTTP POST

 

username – prihlasovacie meno
password - heslo

sender - odosielatel SMS - max 11 znakov

hour - čas odoslania automatickej SMS napr. 09

min - čas odoslania automatickej SMS napr. 30

text - text SMS - max 160 znakov

action - akcia

- nameday: odosielanie SMS k meninám

- birthday: odosielanie SMS k narodeninám

- date: odosielanie SMS k určitej udalosti, ktorá je priradená ku kontaktu v stĺpci "date" v tabuľke kontaktov

- mdate: odosielanie SMS k mesačne opakujúcej sa udalosti, ktorá je priradená ku kontaktu v stĺpci "mdate" v tabuľke kontaktov

- ydate: odosielanie SMS k ročne opakujúcej sa udalosti, ktorá je priradená ku kontaktu v stĺpci "ydate" v tabuľke kontaktov

 

show - načíta zoznam načasovaných SMS na aktuálny deň, ktoré ešte neboli odoslané. Je možné využiť pre prípadne zastavenie

odoslania automatickej SMS.

 


 

10.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


10.3 PRÍKLAD ODPOVEDE


s - status

zamietnutá požiadavka - 0 (IDsms sa nenašlo v databáze)

úspešna editatácia automatickej SMS - 1

 

 

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>1</s>
</r>

 


9.4 PRÍKLAD EDITÁCIE AUTOMATICKEJ SMS

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password
&action=birthday&sender=
$sender&hour=$hour&min=$min&text=$textsms");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/autosms/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
{
case 
200/* $xmlObject = new SimpleXMLElement($data);
$status = $xmlObject->s; */
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

11. Transfer kreditu na iný účet alebo podúčet

 

API URL pre transfer kreditu: http://www.123sms.sk/api/transfer-credit/

 

 

Pomocou api pre transfer kreditu je mozne jednoducho presuvat SMS kredit medzi poductami alebo hlavnými účtami.

10.1 PARAMETRE PRE HTTP POST

 

username – prihlasovacie meno
password - heslo

user -  prihlasovacie meno dobíjaného účtu

value - hodnota kreditu napr. 25.7540

message - správa pre príjemcu (odoslaná emailom z billing@123sms.sk)

type - typ kreditu 1- normálny kredit

 

 


 

11.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


11.3 PRÍKLAD ODPOVEDE


s - status

 

 

s 1 úspešne navýšenie kreditu

s -2 zamietnutá požiadavka, nízky kredit pre transfer na iný účet

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>1</s>
</r>

 


11.4 PRÍKLAD PRE TRANSFER KREDITU NA INÝ ÚČET

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&user=$user
&value=
$value&type=$type&message=$message&hour=$hour&min=$min&text=$textsms");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/transfer-credit/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
{
case 
200/* $xmlObject = new SimpleXMLElement($data);
$status = $xmlObject->s; */
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

 

 

 

12. Dobitie kreditu z SMS kupónu

 

API URL pre dobitie kreditu z SMS kupónu: http://www.123sms.sk/api/coupon-sms/

 

 

12.1 PARAMETRE PRE HTTP POST

 

username – prihlasovacie meno
password - len api kľúč pre partnerov

action - kód kupónu

value - suma kupónu (možné sumy 3, 5, 10, 20, 50)

 


 

12.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


12.3 PRÍKLAD ODPOVEDE


s - status

 

s 1 úspešne navýšenie kreditu

s -2 zamietnutá požiadavka, nesprávny alebo použitý SMS kód

 

 

 

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>1</s>
</r>

 


12.4 PRÍKLAD DOBITIA SMS KUPÓNU

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&code=$code&value=$value
&hour=
$hour&min=$min&text=$textsms");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/coupon-sms/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
{
case 
200/* $xmlObject = new SimpleXMLElement($data);
$status = $xmlObject->s; */
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

 

13. Objednávka SMS kreditu

 

API URL pre objednávku SMS kreditu: http://www.123sms.sk/api/order/

 

 

13.1 PARAMETRE PRE HTTP POST

 

 

username – prihlasovacie meno

password - heslo

value - suma

wallet - wire-transfer, paypal

 

Aktuálne podporujeme len paypal

 

Faktúru je možné uhradiť aj offline, v odpovedi vraciame link na platobný systém pre instant platbu a tiež link na faktúru,

ktorú je možné uhradiť offline

 


 

13.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


13.3 PRÍKLAD ODPOVEDE


s - status

 

s 1 úspešné vytvorenie objednávky

s -2 zamietnutá požiadavka, nesprávne údaje, chýbajúce parametre

 

v - variabilný symbol

i - link na faktúru

w - link na platbu cez zvolený wallet

 

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

    <s>1</s>

    <v>2545445</v>

   <w>http://www.123sms.sk/paypal/?hash=f20d161da3c298128be05bdff5e7d8b299727935</w>

   <i>http://www.123sms.sk/invoices/sk/?invoice=101428251359</i>

</r>

 


13.4 PRÍKLAD OBJEDNÁVKY SMS KREDITU

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&value=$value&wallet=$wallet");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/order/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
{
case 
200/* $xmlObject = new SimpleXMLElement($data);
$status = $xmlObject->s; */
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>

 

 

 

14. Registrácia do SMS brány 123sms.sk

 

API URL pre registráciu do SMS brány: http://www.123sms.sk/api/register/

 

 

13.1 PARAMETRE PRE HTTP POST

 

 

username – prihlasovacie meno *

password - heslo *

firstname - meno

lastname - priezvisko

company - názov firmy

ico - ico

dic - danove identifikacne cislo pre neplatcov DPH

icdph - danove identifikacne cislo pre platcov DPH

street - ulica číslo

postcode - psč

country - krajina

email - email *

sender - odosielateľ *

number - telefónne císlo *

username - prihlasovacie meno *

ref - partnersky kod*

action - akcia *

- register: registrácia

- check-username: overenie prihlasovacieho mena

- check-email: overenie emailu

 

 


 

14.2 ODPOVEĎ

 

Zlyhaná autentifikácia

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>-1</s>
</r>

 

s -1 nesprávne zadané prihlasovanie údaje

 

 


14.3 PRÍKLAD ODPOVEDE


s - status

 

s 1 úspešna registrácia do systému

s -2 zamietnutá požiadavka, nesprávne údaje, chýbajúce parametre

 

 

 

 

<?xml version="1.0" encoding="UTF-8"?>

<r>

   <s>1</s>

<akey>API kľúč</akey>
</r>

 


14.4 PRÍKLAD REgistrÁCIE NOVÉHO ÚČTU

<?php 
$ch 
curl_init() or die(curl_error());
curl_setopt($chCURLOPT_POSTFIELDS"username=$username&password=$password&email=$email&firstname=$firstname
&lastname=
$lastname&sender=$mycompany&number=$number&ref=$promocode&action=register");
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_URL,"http://www.123sms.sk/api/register/");
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_setopt($chCURLOPT_HTTPHEADER, array('Connection: close'));
$data =curl_exec($ch);
if (
curl_errno($ch) ){/* Chyba CURL */
$result 'ERROR -> ' curl_errno($ch) . ':' curl_error($ch);
}
else
{
$returnCode = (int)curl_getinfo($chCURLINFO_HTTP_CODE);
switch(
$returnCode)
{
case 
200/* $xmlObject = new SimpleXMLElement($data);
$status = $xmlObject->s; */
break;
    case 
503:
    
$result 'ERROR -> 503';
    break;
    case 
403:
    
$result 'ERROR -> 403';
    break;
    case 
404:
    
$result 'ERROR -> 404';
    break;
    default: 
$result 'ERROR -> ERROR';
  
  
  }
}
curl_close($ch);?>