API Documentation

  • Home
  • Getting Started

SMS API

  • Overview
  • Send SMS
  • Bulk SMS
  • Send Hashed SMS
  • Send OTP
  • Delivery Reports
  • Delivery Status
  • SMS Balance
  • Common Errors
  • Response Codes

SMS Balance

The SMS Balance API allows you to check your current SMS credit balance. This endpoint helps you monitor your account credits and manage your messaging capacity.

GET Method

Endpoint

https://send.macrologicsys.com/api/services/balance

Parameters

Parameter Description
apikey Your valid API key
partnerID Your Partner ID

Example Request

https://send.macrologicsys.com/api/services/balance?apikey={{apikey}}&partnerID={{partnerID}}

Sample Success Response

{
  "response-code": 200,
  "response-description": "Success",
  "balance": 1500,
  "currency": "Credits"
}

Sample Error Response

{
  "response-code": 1006,
  "response-description": "Invalid credentials"
}

Code Examples

PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => "https://send.macrologicsys.com/api/services/balance?apikey={{apikey}}&partnerID={{partnerID}}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET"
]);
$response = curl_exec($curl);
curl_close($curl);
$result = json_decode($response, true);
echo "Balance: " . $result['balance'] . " " . $result['currency'];
?>

Node.js

const https = require('https');

const options = {
  hostname: 'send.macrologicsys.com',
  path: '/api/services/balance?apikey={{apikey}}&partnerID={{partnerID}}',
  method: 'GET'
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => {
    data += chunk;
  });
  res.on('end', () => {
    const result = JSON.parse(data);
    console.log('Balance:', result.balance, result.currency);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.end();

Python

import requests

url = "https://send.macrologicsys.com/api/services/balance"
params = {
    "apikey": "{{apikey}}",
    "partnerID": "{{partnerID}}"
}

response = requests.get(url, params=params)
result = response.json()
print(f"Balance: {result['balance']} {result['currency']}")

Last Updated: 2/24/2025 | Contributors: Macrologic API Team

Related Endpoints

  • Send SMS
  • Response Codes

© 2025 All rights reserved | info@macrologicsys.com