Send SMS

From Boxis.net API Docs
Revision as of 10:50, 9 May 2012 by Admin (Talk | contribs)

Jump to: navigation, search

SMS Function: Send SMS

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

Input params

- sender_name::String
- recipients::Array of Strings
- content::String
- flash::Boolean::0/1 (optional)
- fast::Boolean::0/1 (optional)
- schedule::Boolean::0/1 (optional)
- timesend::String Format 'YYYY-MM-DD HH:MM' (optional, when schedule is 1)

Output params

Example in XML (Success)

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>
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>
Bulk SMS (no scheduled)
<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params>
    <sended>
      <sms1>
        <id>133654685431563000002080</id>
        <phone>48511141565</phone>
      </sms1>
      <sms2>
        <id>133654685409553000016930</id>
        <phone>48514645553</phone>
      </sms2>
    </sended>
    <not_sent>
       <phone>48714645553</phone>
    </not_sent>
  </params>
  <timestamp>1335767184</timestamp>
</return>
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>
error
<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>0</result>
  <resulttxt>Error: {error description}</resulttxt>
  <params/>
  <timestamp>1335767184</timestamp>
</return>

Example in Json

success
{"result":"1",
 "resulttxt":"success",
 "params":[],
 "timestamp":1335777400}
error
{"result":"0",
 "resulttxt":"Error: {error description}",
 "params":[],
 "timestamp":1335777400}

Errors Descriptions

- 'domain' is not valid
- there is no such tld
- 'years' value is not valid
- 'ns' could not be greater than five
- 'protect-privacy' value is not valid
- domain 'testdomain.com' is not available
- domain not created