Voice Monitoring API

The Voice Monitoring API gives you on-demand access to data about your voice calls. Think of it as your personal dashboard in data form — instead of logging into a portal, you can pull the exact call metrics you need, whenever you need them, and use them in your own tools, reports, or dashboards. Whether you want to know how many calls went through last week, what percentage of calls failed, or how long the average call lasted, this API has you covered.

Take Control of Your Call Quality

With the Voice Monitoring API you can:

• Stay on top of call quality — Quickly spot if something is going wrong with your calls before your customers notice.
• Track usage trends — See how your call volumes change over time and plan accordingly.
• Build your own reports — Feed this data directly into your internal dashboards, spreadsheets, or business intelligence tools.
• Get answers fast — No need to wait for a monthly report. Query your data any time, for any time range you choose.

Available Metrics

What Metrics Are Available?

Metric	What It Tells You
Total Calls	How many calls were made in a given period
Completed Calls	How many of those calls were successfully completed
Failed Calls	How many calls did not connect or were dropped
Connection Rate	The percentage of calls that successfully connected
Error Percentages	Breakdown of calls that failed due to different types of errors
Minutes of Use	Total minutes spent on calls
Average Call Duration	The average length of a call
Short Calls	Aggregated summary of short calls, including both call counts and percentages (a common signal of quality issues)
Calls Per Second	How many calls were happening at any given second (inbound and outbound)
Concurrent Calls	How many calls were active at the same time
Network Efficiency Ratio	A measure of how efficiently your calls are using the network

---

You can filter all of these metrics by:

• Date and time range — e.g., "just the last 7 days" or "January through March"
• Direction — Inbound calls, outbound calls, or both
• Phone number — A specific number you called from or to
• Call type — Local, international, toll-free, emergency, etc.
• Sub-account — If you manage multiple accounts under one umbrella
• Call result — Completed or incomplete calls
• And more — Country of origin/destination, hang-up source, error codes

How Do I Get Access?

Access to the Voice Monitoring API is controlled by Bandwidth. To get started:

1. Contact your Bandwidth account representative and let them know you'd like access to the Voice Monitoring API.
2. Once approved, your account will be enabled for this feature.
3. For more information on how to use the API please refer to the API Reference.

If you are unsure who your account representative is, reach out to Bandwidth Support.

How Does It Work? (A Simple Overview)

Once you have access, here's the basic flow:

1. You send a request to the API specifying:
   • Which metric you want (e.g., total calls)
   • Your account ID
   • Any filters (e.g., date range, call direction)
2. The API returns a response with your data broken down by time intervals, based on the time span you have requested.
3. You can use that data however you like — display it in a dashboard, load it into a spreadsheet, trigger alerts, etc.

Example: "How many calls did I make last month?"

You would ask the API for Total Calls, filtered to your account and the date range of last month. The API would return a list of daily call counts covering that period.

Example: "Are my calls failing more than usual?"

You would ask for Error Percentages or Failed Calls for the past few weeks. If the numbers are higher than your normal baseline, that's a signal to investigate further.

What Does the Data Look Like?

The API returns data as a list of time-based "slices" — one entry per day (shorter time ranges are more granular than longer ones). Each slice tells you the value of the metric for that point in time. For example, a response for Total Calls might look like:

January 1  →  1,204 calls
January 2  →  1,376 calls
January 3  →    987 calls

This makes it easy to chart trends over time.

Is My Data Secure?

Yes. All communication with the API is encrypted (HTTPS), the account level access ensures that only authorized users and applications can access your account's data.

Need Help?

If you run into any issues or have questions, please reach out to your Bandwidth account representative or contact Bandwidth Support