App Balance API

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in CHUB dashboard. After getting the app id and secret, make a POST request to the below base URL to retrieve the details of main balance, sms balance and expiry date of your app.

Base URL

Send your POST method request with valid parameters, to the following base URL.

https://rest.telecmi.com/v2/balance

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
appid	number	Your app ID
secret	string	Your app secret

Note

All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "appid": 1111113,
  "secret": "xxxx-xxxx-xxxx-xxxx"
}

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

{
  "code": 200,
  "expire": 1635921536108,
  "sms": 10969,
  "balance": 1765
}

Properties

These are the list of properties and its description

Property	Type	Description
expire	number	The expiry date in timestamp
sms	number	The available SMS balance
balance	number	The availble call balance in inr or usd

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status code	Status type	Description
200	OK	We received the request
404	Error	Invalid app id or secret, authentication failed
400	Error	Parameter missing