Difference between revisions of "Calculate Credits"
From Boxis.net API Docs
(→Example in Json (Success)) |
(→Input params) |
||
| Line 31: | Line 31: | ||
|- | |- | ||
| - '''fast''' (Boolean) - optional | | - '''fast''' (Boolean) - optional | ||
| − | ''Setting this parameter 1 when message | + | ''Setting this parameter 1 if you want to know how many credits you need to when the message is sent in fast mode'' |
|- | |- | ||
|} | |} | ||
Revision as of 13:18, 9 May 2012
Contents
SMS Function: calculateCredits
With this command, you are able to get how many credits you need to send a message.
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 'calculateCredits' value |
| - recipients_count (Integer)
Number of message recipients |
| - content (Integer)
The message text |
| - fast (Boolean) - optional
Setting this parameter 1 if you want to know how many credits you need to when the message is sent in fast mode |
Output params
Example in XML (Success)
<?xml version="1.0" encoding="UTF-8"?>
<return>
<result>1</result>
<resulttxt>success</resulttxt>
<params>
<credit>4</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":{
"credit":4}
"timestamp":1335777400}
Example in Json (Error)
{"result":"0",
"resulttxt":"Error: {error description}",
"timestamp":1335777400}
