Real-Time Data (V2)

Real-Time Data (V2)

Real-Time Queues (API Access)

This API endpoint allows you to retrieve real-time data from queues within a phone system container. It is useful for monitoring active queue performance, agent activity, and call volume in real time.


Endpoint


Request Type: GET

Endpoint URL: https://pbx.primevox.net/api/reports/raw/queue/realtime?auth=&containerID=&tenantID=


Required Parameters

Alert
Note: All parameters are case sensitive.
  1. auth (string):
    1. The authorization key found in the phone system’s Advanced menu. This is a long string of characters and may appear as nonsensical text.
  2. containerID (integer):
    1. The 6-digit Container ID visible in the top-left corner of the Dashboard when logged into a specific container.
  3. tenantID (integer, optional):
    1. The 3-digit Tenant ID that identifies a specific customer on a container.
    2. If omitted or set to 0, the system defaults to the Default Tenant.

Example Usage


GET: https://pbx.primevox.net/api/reports/raw/queue/realtime?auth=abcd1234xyz&containerID=123456&tenantID=001 
​
This call would return real-time queue data for Tenant 001 within Container 123456 using the provided authentication key.