Difference between revisions of "Get Credit Limit"
From Boxis.net API Docs
(→Input params) |
|||
| Line 16: | Line 16: | ||
|- | |- | ||
| - '''authcode''' (String) | | - '''authcode''' (String) | ||
| − | '' md5 | + | '' md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))'' |
|- | |- | ||
| - '''section''' (String) | | - '''section''' (String) | ||
| − | ''Use 'sms' value | + | ''API module name. Use 'sms' value |
|- | |- | ||
| − | | - ''' | + | | - '''action''' (String) |
| − | '' | + | ''API module function. Use 'getCreditLimit' value |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|- | |- | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Output params === | === Output params === | ||
Revision as of 12:59, 9 May 2012
Contents
SMS Function: getCreditLimit
With this command, you are able to get available credit.
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>
<params>
<credit>186</credit>
</params>
<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":{
"sms_id":"133655724631563000002130"}
"timestamp":1335777400}
Single Scheduled SMS
{"result":"1",
"resulttxt":"success",
"params":{
"credit":"186"}
"timestamp":1335777400}
Example in Json (Error)
{"result":"0",
"resulttxt":"Error: {error description}",
"timestamp":1335777400}
