Revision as of 09:50, 24 May 2012

SMS Function: sendSMS

With this command, you are able to send SMS with boxis.net.

Input params

• version::String - API version (e.g. '1.0')

• timestamp::String - Sequence of characters, denoting the date and time (e.g '1336553826')

• username::String - User e-mail address (e.g 'mail1@example.com')

• authcode::String - md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))

• section::String - API module name. Use 'sms' value

• action::String - API module function. Use 'sendSMS' value

• content::String - The message text. Content of one message is normally 160 characters per single SMS or 70 in case of using at least one special character (polish characters are considered to be special characters). The maximal message is set to 459 normal characters or 201 if special chars are used and it is being sent as one block of 3 messages joined together and charged as three messages.

• flash::Boolean (optional) - Sending a message in flash mode can be activated by setting this parameter to 1

• fast::Boolean (optional) - Setting this parameter to „1” will result in sending message with the highest priority which ensures the quickest possible time of delivery. This parameter may be used for both PRO and ECO messages. Fast messages costs 50% more than normal message. Attention! Mass and marketing messages mustn’t be sent with fast parameter

• schedule::Boolean (optional) - Adding a message to the schedule can be activated by setting this parameter to 1

• timesend::String (optional, use when schedule is 1) - Date in 'yyyy-mm-dd hh:mm' format when message will be sent. Setting a past date will result in sending message instantly

Example URL with POST values

https://boxis.net/xmlapi.php
POST: returntype=xml&sender_name=boxis.net&recipients=a:1:{i:0;s:11:"48599131568";}&content=test1&version=1.0&username=your@mail.com&timestamp=1337844592&authcode=1234567890&json=sms&action=sendSMS

Output params

Example in XML (Success)

• Send Single SMS (no scheduled)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params>
    <sms_id>133655645431563000007320</sms_id>
  </params>
  <timestamp>1335767184</timestamp>
</return>

• Send Single Scheduled SMS

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params>
    <sms_id>133655645431563000007320</sms_id>
  </params>
  <timestamp>1335767184</timestamp>
</return>

• Send Bulk SMS (no scheduled)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params>
    <sent>
      <sms1>
        <id>133654685431563000002080</id>
        <phone>48511141565</phone>
      </sms1>
      <sms2>
        <id>133654685409553000016930</id>
        <phone>48514645553</phone>
      </sms2>
    </sent>
    <not_sent>
       <phone>48714645553</phone>
    </not_sent>
  </params>
  <timestamp>1335767184</timestamp>
</return>

• Send Bulk Scheduled SMS

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params>
    <scheduled>
      <sms1>
        <id>133654685431563000002080</id>
        <phone>48511141565</phone>
      </sms1>
      <sms2>
        <id>133654685409553000016930</id>
        <phone>48514645553</phone>
      </sms2>
    </scheduled>
    <not_scheduled>
       <phone>48714645553</phone>
    </not_scheduled>
  </params>
  <timestamp>1335767184</timestamp>
</return>

Example in XML (Error)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>0</result>
  <resulttxt>error: {error description}</resulttxt>
  <timestamp>1335767184</timestamp>
</return>

Example in JSON (Success)

• Send Single SMS (no scheduled)

{"result":"1",
 "resulttxt":"success",
 "params":{
   "sms_id":"133655724631563000002130"}
 "timestamp":1335777400}

• Single Scheduled SMS

{"result":"1",
 "resulttxt":"success",
 "params":{
   "sms_id":"133655724631563000002130"}
 "timestamp":1335777400}

• Send Bulk SMS (no scheduled)

{"result":"1",
 "resulttxt":"success",
 "params":{
   "sent":{
     "sms1":{
       "id":"133655714331563000008070",
       "phone":"48511131564"}},
    "not_sent":{
      "sms1":"48717131563",
      "sms2":"48611171563"}},
 "timestamp":1335777400}

• Send Bulk Scheduled SMS

{"result":"1",
 "resulttxt":"success",
 "params":{
   "scheduled":{
     "sms1":{
       "id":"133655714331563000008070",
       "phone":"48511131564"}},
    "not_scheduled":{
      "sms1":"48717131563",
      "sms2":"48611171563"}},
 "timestamp":1335777400}

Example in JSON (Error)

{"result":"0",
 "resulttxt":"Error: {error description}",
 "timestamp":1335777400}

Example using our PHP Class

/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey   = '1234567890';        // your apikey

/* API COMMAND DETAILS */
$apitype  = 'sms';
$command  = 'sendSMS';
$params   = array(
    'returntype' => 'xml',
    'sender_name' => 'boxis.net',
    'recipients' => array('48599131568'),
    'content' => 'test1',
);

/* PROCESS THE ACTION */
$boxisAPI = new BoxisAPIConnection($email, $apikey);
$return = $boxisAPI->call($apitype, $command, $params);