Difference between revisions of "Send SMS"

From Boxis.net API Docs
Jump to: navigation, search
Line 24: Line 24:
 
=== Output params ===
 
=== Output params ===
  
==== example in XML ====
+
==== Example in XML ====
  
===== success =====
+
===== Success =====
'''Simple single SMS'''
+
====== Simple single SMS =====
 
<pre>
 
<pre>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>

Revision as of 11:43, 9 May 2012

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
= Simple single 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>
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