Call Control

List active calls

Retrieves all currently active calls for a given provider within an application. Use this endpoint to monitor live call activity and manage call sessions in real time.

Use Cases

Ideal for:

Powering call center dashboards showing current call volume
Identifying active calls for possible intervention
Supporting analytics and reporting on concurrent call usage

Behavior and Implementation Notes

Returns calls that are in progress (e.g. answered and connected). Depending on provider behavior, calls in ringing, on hold, or recently disconnected states may also appear. Results are limited to the specified provider and application. Data updates in near real-time but may reflect minor delays due to provider sync intervals.

GET/v1/accounts/:accountID/applications/:applicationID/provider/:providerID/calls

curl --request GET \
  --url http://api.voistrix.com/v1/accounts/:accountID/applications/:applicationID/provider/:providerID/calls \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Path Parameters

:accountID - REQUIRED[String]
The referenced account ID.
:applicationID - REQUIRED[String]
The referenced application ID.
:providerID - REQUIRED[String]
The referenced provider ID.

Calls Response - [Map]

Collection of call records with metadata.

Attributes

calls - REQUIRED[Array]
A collection of call details.
List Contents (calls)- type of [Map]
- calls[0].answeredAt - OPTIONAL[String]
  Call answer timestamp.
- calls[0].callID - REQUIRED[String]
  Unique call identifier.
- calls[0].chosenContactID - OPTIONAL[String]
  Selected contact identifier for the call.
- calls[0].endedAt - OPTIONAL[String]
  Call termination timestamp.
- calls[0].isMissedCall - REQUIRED[Boolean]
  Indicates if inbound call was missed. Only applicable for inbound calls.
- calls[0].isOutbound - REQUIRED[Boolean]
  Indicates if call is outbound.
- calls[0].providerCallID - REQUIRED[String]
  Provider's unique call identifier.
- calls[0].providerID - REQUIRED[String]
  Provider identifier for call origin.
- calls[0].providerName - REQUIRED[String]
  Phone system provider name.
- calls[0].remoteName - OPTIONAL[String]
  Remote caller's name.
- calls[0].remoteNumber - REQUIRED[String]
  Remote party's phone number.
- calls[0].startedAt - REQUIRED[String]
  Call initiation timestamp.
- calls[0].subscriberEmail - OPTIONAL[String]
  Subscriber's email address.
- calls[0].subscriberExtension - OPTIONAL[String]
  Subscriber's extension number.
- calls[0].subscriberFirstName - OPTIONAL[String]
  Subscriber's first name.
- calls[0].subscriberID - OPTIONAL[String]
  Unique subscriber identifier.
- calls[0].subscriberLastName - OPTIONAL[String]
  Subscriber's last name.
- calls[0].subscriberNumber - OPTIONAL[String]
  Subscriber's phone number.
fromDate - OPTIONAL[String]
Start date filter for call listing.
toDate - OPTIONAL[String]
End date filter for call listing.
totalCalls - REQUIRED[Integer]
Total number of calls returned.

Calls Response Shape

{
  "calls": [
    {
      "answeredAt": "string",
      "callID": "string",
      "chosenContactID": "string",
      "endedAt": "string",
      "isMissedCall": true,
      "isOutbound": true,
      "providerCallID": "string",
      "providerID": "string",
      "providerName": "string",
      "remoteName": "string",
      "remoteNumber": "string",
      "startedAt": "string",
      "subscriberEmail": "string",
      "subscriberExtension": "string",
      "subscriberFirstName": "string",
      "subscriberID": "string",
      "subscriberLastName": "string",
      "subscriberNumber": "string"
    }
  ],
  "fromDate": "string",
  "toDate": "string",
  "totalCalls": 0
}

Errors

A common set of Error Responses can be found here.