Difference between revisions of "Send SMS"
From Boxis.net API Docs
(Created page with "=SMS Function: Register= With this command, you are able to send SMS with boxis.net. === Input params === {| |- | - '''sender_name'''::String::Domain name that you need to R...") |
|||
| Line 1: | Line 1: | ||
| − | =SMS Function: | + | =SMS Function: Send SMS= |
With this command, you are able to send SMS with boxis.net. | With this command, you are able to send SMS with boxis.net. | ||
| Line 6: | Line 6: | ||
{| | {| | ||
|- | |- | ||
| − | | - '''sender_name'''::String | + | | - '''sender_name'''::String |
|- | |- | ||
| − | | - '''recipients'''::Array of Strings | + | | - '''recipients'''::Array of Strings |
|- | |- | ||
| − | | - '''content'''::String | + | | - '''content'''::String |
|- | |- | ||
| − | | - '''flash'''::Boolean:: | + | | - '''flash'''::Boolean::0/1 (optional) |
| − | | | + | | |
| − | | - '''fast'''::Boolean:: | + | | - '''fast'''::Boolean::0/1 (optional) |
| − | | | + | | |
| − | | - '''schedule'''::Boolean:: | + | | - '''schedule'''::Boolean::0/1 (optional) |
| − | | | + | | |
| − | | - '''timesend'''::String Format Y-m-d H:i:s (optional, when schedule is 1) | + | | - '''timesend'''::String Format Y-m-d H:i:s (optional, when schedule is 1) |
|} | |} | ||
Revision as of 11:14, 9 May 2012
Contents
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 Y-m-d H:i:s (optional, when schedule is 1) |
Output params
example in XML
success
<?xml version="1.0" encoding="UTF-8"?> <return> <result>1</result> <resulttxt>success</resulttxt> <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 |
