Difference between revisions of "Get Sender Names"

From Boxis.net API Docs
Jump to: navigation, search
(Created page with "=SMS Function: getSenderNames= With this command, you are able to get sender names list. === Input params === {| |- | - '''version''' (string) ''API version (e.g. '1.0')'' |...")
 
(Example in XML (Success))
Line 38: Line 38:
 
       <sender1>HQSMS</sender1>
 
       <sender1>HQSMS</sender1>
 
       <sender2>boxis.net</sender2>
 
       <sender2>boxis.net</sender2>
    </senders>
+
  </senders>
 
   <timestamp>1336558351</timestamp>
 
   <timestamp>1336558351</timestamp>
 
</return>
 
</return>

Revision as of 12:03, 9 May 2012

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 'getCreditLimit' 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}