Use this api to check sms account balance.
URL - https://app.bongasms.co.ke/api/check-credits
METHOD - GET
Response : JSON
Request Parameters
| Name | Description | Type | Option |
|---|---|---|---|
| apiClientID | API Client ID (Provided above) | Numeric | Mandatory |
| key | API Key (Provided above) | String | Mandatory |
Response Parameters
| Name | Description | Type | Option |
|---|---|---|---|
| status | Status of the request (222 - success, 666 - error) | Numeric | Mandatory |
| status_message | Description of status | String | Mandatory |
| client_name | Name of oganization as registered on Bonga | String | Mandatory |
| sms_credits | SMS credits | String | Mandatory |
| sms_threshold | Top up alert threshold | String | Mandatory |
| api_client_id | Organization Bonga ID, assigned on registration | String | Mandatory |
curl --location --request GET 'https://app.bongasms.co.ke/api/check-credits?apiClientID=605&key=SLn4VDUnPRomPjzB'
{
"status": 222,
"status_message": "fetched credits",
"api_client_id": 605,
"client_name": "Kenya LTD",
"sms_credits": 123455,
"sms_threshold": 500,
"email_credits": 0,
"utility_credits": 0
}
{
"status": 222,
"status_message": "fetched credits",
"api_client_id": 605,
"client_name": "Kenya LTD",
"sms_credits": 123455,
"sms_threshold": 500,
"email_credits": 0,
"utility_credits": 0
}