English | Slovak

smsSendBillXML

Popis
Odoslanie spoplatnenej SMS pomocou metódy POST.
Funkčnosť
Spoplatnenú SMS je možné odoslať až v prípade, že partner obdrží prijatú SMS od užívateľa. Súčasťou každej prijatej SMS správy je parameter rcv_msg_id. Tento parameter sa musí uviesť pri odoslaní SMS správy.

Všetky requesty sa zasielajú na URL uvedené nižšie. Formát tela správy je nutné dodržať pre úspešné odoslanie správy.
V prípade úspešného odoslania je vrátený HTTP response 200 a v body je uvedená odpoveď. V prípade chyby je vrátený chybový HTTP response s uvedením chyby.
Request
POST http://text421.naimar.sk/api/v6/rest/billsms/xml
Telo správy
<sms>
   <username>test</username>
   <password>test</password>
   <billing>
      <billkey>1234</billkey>
      <from>7401</from>
   </billing>  
   <message>
      <text>Test SMS</text>
   </message>
   <recipients>
      <recipient>
         <id>123456</id>
         <rcv_msg_id>25481978</rcv_msg_id>
         <msisdn>421901727051</msisdn>
      </recipient>
      <recipient>
         <id>789412</id>
         <rcv_msg_id>25481979</rcv_msg_id>
         <msisdn>421901727053</msisdn>
      </recipient>
   </recipients>
</sms>        
Parameter Required Type Description
username
required Varchar (16) prihlasovacie meno užívateľa
password
required varchar (16) heslo užívateľa
Billing
billkey
required varchar billingový klúč
from
required integer krátke číslo, s ktorého bude odoslaná spoplatnená SMS
Message
text
required text Text SMS správy. Štandardná textová správa - 160 znakov, binárna správa - 280 znakov
type
optional binary binary - binárna správa
dcs
optional integer ak nie je DCS uvedené a správa je binárna, použije sa štandardné DCS 245
esm
optional integer ak nie je ESM uvedené a správa je binárna, použije sa štandardné ESM 64
delivery
optional timestamp nepovinný parameter, čas kedy najskôr sa SMS odošle (napríklad: 2012-11-05 16:01:22)
Recipients
id
required varchar (14) unikátne ID zaslanej SMS
rcv_msg_id
required integer unikátne ID prijatej SMS
msisdn
required integer čislo na ktoré sa má odoslať SMS
Response
Parameter Typ Popis
status integer response serveru (200 ak API prijalo správu, 4xx v prípade chyby)
description varchar (300) bližší popis chyby
recipients integer počet prijatých MSISDN
Error response
Chybové návratové hodnoty
ID chyby Description Vysvetlenie
400 unknown prefix xxx neznámy prefix, použite mobilné prefixy mobilných operátorov
400 unknown network xxx nemáte povolenie na odoslanie SMS do uvedenej siete
400 missing incoming msg nenašla sa prijatá SMS s uvedenými parametrami rcv_msg_id
400 missing parameter rcv_msg_id chýba povinný parameter rcv_msg_id
400 missing parameter id chýba povinný parameter id
400 missing parameter text chýba povinný parameter text
400 missing parameter recipients nie je uvedený žiadny príjemca
400 unknown type type môže byť len binary
401 unknown username/password nesprávne meno alebo heslo
500 unknown error neznáma chyba, bližší popis je zaslaný v response
Revízia
Verzia Dátum Popis
6.0 16.7.2014 prvá verzia