Send SMS
From Boxis.net API Docs
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 '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> <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>
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)
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}
Bulk SMS (no scheduled)
{"result":"1", "resulttxt":"success", "params":{ "sent":{ "sms1":{ "id":"133655714331563000008070", "phone":"48511131564"}}, "not_sent":{ "sms1":"48717131563", "sms2":"48611171563"}}, "timestamp":1335777400}
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}
Errors Descriptions
- 'sender_name' is not valid |
- 'recipients' value is not valid |
- 'content' value is not valid |
- 'flash' value is not valid |
- 'fast' value is not valid |
- 'schedule' value is not valid |
- 'timesend' is not valid |