Get Sender Names

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

Jump to: navigation, search

SMS Function: getSenderNames

With this command, you are able to get sender names list.

Input params

- version (string)

API version (e.g. '1.0')

- timestamp (String)

Sequence of characters, denoting the date and time (e.g '1336553826')

- username (String)

User e-mail address (e.g 'mail1@example.com')

- authcode (String)

md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))

- section (String)

API module name. Use 'sms' value

- action (String)

API module function. Use 'getSenderNames' value

Output params

Example in XML (Success)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <senders>
      <sender1>HQSMS</sender1>
      <sender2>boxis.net</sender2>
  </senders>
  <timestamp>1336558351</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)

{"result":"1",
 "resulttxt":"success",
 "params":{
   "senders":{
     "sender1":"HQSMS",
     "sender2":"boxis.net"}}
 "timestamp":1335777400}

Example in Json (Error)

{"result":"0",
 "resulttxt":"Error: {error description}",
 "timestamp":1335777400}