Get Credit Limit Contents 1 SMS Function: getCreditLimit 1.1 Input params 1.2 Example URL with POST values 1.3 Output params 1.3.1 Example in XML (Success) 1.3.2 Example in XML (Error) 1.3.3 Example in JSON (Success) 1.…

Get Credit Limit

Last updated: April 2026
Reading time: ~3 min
Audience: Boxis customers and administrators.

What you'll accomplish

Complete the configuration or task described in this guide for your Boxis service.

Prerequisites

Access to the interface, device, or server described below.
Information or credentials you received from Boxis (contract, welcome e-mail, or client area).

Note Boxis: Offers and screens may differ slightly depending on your product. When in doubt, open a support ticket with your service reference.

Get Credit Limit

1 SMS Function: getCreditLimit - 1.1 Input params - 1.2 Example URL with POST values - 1.3 Output params - 1.3.1 Example in XML (Success) - 1.3.2 Example in XML (Error) - 1.3.3 Example in JSON (Success) - 1.3.4 Example in JSON (Error) - 1.4 Example using our PHP Class

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);
}
/*

Expected result

The product behaves as described in each step (connectivity, message, or UI state).

If something goes wrong

Repeat the step and check for typos (hostnames, passwords, ports).
Note the exact error message or screenshot.
Open a ticket in the Boxis client area with the service name, time of the test, and any trace (e.g. traceroute) if it is a network issue.