Difference between revisions of "Get Credit Limit"

From Boxis.net API Docs
Jump to: navigation, search
(→‎Example URL with POST values)
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
 
=SMS Function: getCreditLimit=
 
=SMS Function: getCreditLimit=
  
 
With this command, you are able to get available credit.
 
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')
 
−
|-
 
−
| - '''content'''::String::The message text. Content of one message is normally 160 characters per single
 
−
SMS or 70 in case of using at least one special character (polish characters are
 
−
considered to be special characters). The maximal message is set to 459 normal
 
−
characters or 201 if special chars are used and it is being sent as one block of 3
 
−
messages joined together and charged as three messages.
 
−
|-
 
−
| - '''flash'''::Boolean::0/1 (optional)
 
−
|-
 
−
| - '''fast'''::Boolean::0/1 (optional)
 
−
|-
 
−
| - '''schedule'''::Boolean::0/1 (optional)
 
−
|-
 
−
| - '''timesend'''::String Format 'YYYY-MM-DD HH:MM' (optional, when schedule is 1)
 
−
|-
 
−
|}
 
  
−
'version' => '1.0',
+
== Input params ==
−
        'returntype' => 'json',
+
−
        'timestamp' => $timestamp,
+
−
        'username' => 'konrad@modulesgarden.com',
+
−
        'authcode' => md5($timestamp. 'BX3KwWU2SuqvoEWnjYmOibf'),
+
−
        'section' => 'sms',
+
−
        'action' => 'getCreditLimit', 
+
  
−
=== Output 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
 +
 
 +
 
 +
== Example URL with POST values ==
 +
 
 +
<pre>
 +
http://api.boxis.net/
 +
POST: version=1.0&returntype=xml&timestamp=1337853135&username=your@mail.com&authcode=1234567890&section=sms&action=getCreditLimit
 +
</pre>
 +
 
 +
== Output params ==
  
 
==== Example in XML (Success) ====
 
==== Example in XML (Success) ====
Line 61: Line 54:
 
</pre>
 
</pre>
  
−
==== Example in Json (Success) ====
+
==== Example in JSON (Success) ====
  
 
<pre>
 
<pre>
Line 71: Line 64:
 
</pre>
 
</pre>
  
−
===== Single Scheduled SMS =====
+
==== Example in JSON (Error) ====
 +
 
 
<pre>
 
<pre>
−
{"result":"1",
+
{"result":"0",
−
  "resulttxt":"success",
+
  "resulttxt":"Error: {error description}",
−
"params":{
+
−
  "credit":"186"}
+
 
  "timestamp":1335777400}
 
  "timestamp":1335777400}
 
</pre>
 
</pre>
  
−
==== Example in Json (Error) ====
 
  
 +
== Example using our PHP Class ==
 
<pre>
 
<pre>
−
{"result":"0",
+
/* API LOGIN DETAILS */
−
  "resulttxt":"Error: {error description}",
+
$email    = 'your@mail.com';    // your username
−
"timestamp":1335777400}
+
$apikey  = '1234567890';        // your apikey
 +
 
 +
/* API COMMAND DETAILS */
 +
$apitype = 'sms';
 +
$command  = 'getCreditLimit';
 +
$params  = array();
 +
 
 +
/* 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);
 +
}
 +
/*
 +
 
 
</pre>
 
</pre>

Latest revision as of 13:57, 26 October 2012

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


Example URL with POST values

http://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853135&username=your@mail.com&authcode=1234567890&section=sms&action=getCreditLimit

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}

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  = 'getCreditLimit';
$params   = array();

/* 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);
}
/*
Retrieved from "https://apidocs.boxis.net/index.php?title=Get_Credit_Limit&oldid=330"