Revision as of 14:09, 26 June 2012

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::String - 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

Example URL with POST values

https://boxis.net/xmlapi.php
POST: version=1.0&returntype=xml&timestamp=1337853387&username=your@mail.com&authcode=1234567890&section=sms&action=calculateCredits&recipients_count=1&content=test1

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}

Example using our PHP Class

/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey   = '1234567890';        // your apikey

/* API COMMAND DETAILS */
$apitype  = 'sms';
$command  = 'calculateCredits';
$params   = array(
    'returntype' => 'xml',
    'recipients_count' => 4,
    'content' => 'test1',
);

/* PROCESS THE ACTION */
$boxisAPI = new BoxisAPIConnection($email, $apikey);
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);

/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)
if($return['timestamperror']) {
    $timestamp = $return['timestamp'];
    $return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);
}
*/

/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/
/*
if($return->timestamperror) {
    $timestamp = $return->timestamp;
    $return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);
}
/*