CkPhp Requires Chilkat v11.0.0+
CkPhp
Clickatell One API: Read the account balance and currency
See more Clickatell Examples
Request the messaging balance associated with a One API integration key. The response supplies both the decimal amount and its currency. Read the amount as text for display to preserve its precision. A zero balance is a valid result. For example, a billing dashboard can display 1267.92865 ZAR.
Chilkat CkPhp Downloads
<?php
include("chilkat.php");
$success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$http = new CkHttp();
$http->put_RequireSslCertVerify(true);
// Supply the key for this One API integration from application configuration.
$http->SetRequestHeader('Authorization','ONE_API_KEY');
$http->SetRequestHeader('Accept','application/json');
$resp = new CkHttpResponse();
$success = $http->HttpNoBody('GET','https://platform.clickatell.com/v1/balance',$resp);
if ($resp->get_StatusCode() == 0) {
print 'No HTTP response. Check the connection and retry the lookup.' . "\n";
exit;
}
$reply = new CkJsonObject();
$parsed = $reply->Load($resp->bodyStr());
if (($success != true) or (($resp->get_StatusCode() != 200))) {
print 'Clickatell returned HTTP ' . $resp->get_StatusCode() . "\n";
if ($parsed == true) {
if ($reply->HasMember('error.description') == true) {
print $reply->stringOf('error.description') . "\n";
}
}
exit;
}
if ($parsed != true) {
print 'Expected a JSON response.' . "\n";
exit;
}
// JsonTypeOf returns 2 for a number and 1 for a string. Zero is a valid amount.
if (($reply->JsonTypeOf('balance') != 2) or ($reply->JsonTypeOf('currency') != 1)) {
print 'The balance response is missing the amount or currency.' . "\n";
exit;
}
print 'Account balance: ' . $reply->stringOf('balance') . ' ' . $reply->stringOf('currency') . "\n";
?>