The Voiso Contact Center Balance APIs enable you to perform functions related to contact center administration. Use it to obtain the balance owed to Voiso for contact center services.
You can use the Balance API to create an application to track your contact center's billing balance and automatically make payments or trigger alerts when your balance is low.
The Balance API is part of Voiso's Contact Center Management APIs. The API description is here.
The balance API requires the base URL (cluster_id) and the The Contact Center API key) (client_api_key). It uses the following parameters to initiate a call:
The contact center API key. Voiso responds with the current balance owing.
For example:
https://cluster1.voiso.com/api/v1/cc7c76...b89bb6c3/balance
Or as a JSON request:
{
"method": "GET",
"url": "https://cluster1.voiso.com/api/v1/cc7c76...b89bb6c3/balance",
"headers": {
"Accept": "application/json",
}
}
The response to the request is a key-value pair of type number. The value is a float indicating the balance owing in US$.
{
"balance": 3562.67
}
The following issues are sometimes encountered:
The balance API requires the contact center API key to validate the request. If you see this error, "error": "Invalid api_key", check that you are using the correct contact center API key. For more information about API keys, refer to Authentication.
Was this page helpful?