Difference between revisions of "Send SMS"

From Boxis.net API Docs
Jump to: navigation, search
(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...")
(No difference)

Revision as of 11:10, 9 May 2012

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 Register
- recipients::Array of Strings::List of Name Servers to be associated with the domain name. A maximum of 5 Name Servers can be specified
- content::String::Domain name that you need to Register
- flash::Boolean::Enables (optional) / Disables the Privacy Protection setting for the domain name. Possible values are: 1 or 0

| - fast::Boolean::Enables (optional) / Disables the Privacy Protection setting for the domain name. Possible values are: 1 or 0 |} | - schedule::Boolean::Enables (optional) / Disables the Privacy Protection setting for the domain name. Possible values are: 1 or 0 |} | - timesend::String Format Y-m-d H:i:s (optional, when schedule is 1) / Disables the Privacy Protection setting for the domain name. Possible values are: 1 or 0 |}

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