GetBriefCallHistory
Gets the account’s brief call history in the asynchronous mode. Take a look at the [GetHistoryReports] and [DownloadHistoryReport] functions for downloading details.
Allowed roles: Owner, Admin, Developer, Supervisor, Support.
Example request: Get the brief call session history from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.
Authentication
Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:
Authorization: Bearer $VOXIMPLANT_TOKEN
See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.
Query parameters
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). You can find the session ID in the AppEvents.Started event's sessionID property in a scenario, or retrieve it from the call_session_history_id value returned from the StartScenarios or StartConference methods
The application name, can be used instead of application_id
To receive the call history for a specific routing rule, pass the rule name to this parameter. Applies only if you set application_id or application_name
To receive a call history for a specific remote numbers, pass the number list separated by semicolons (;). A remote number is a number on the client side
To receive a call history for a specific local numbers, pass the number list separated by semicolons (;). A local number is a number on the platform side
To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter
Whether to get a CSV file with the column names if the output=csv
The output format. The following values available: csv.