Rate this page:

GetBriefCallHistoryRequest

Props

applicationId

Copy URL
var applicationId: 

To receive the call history for a specific application, pass the application ID to this parameter

applicationName

Copy URL
var applicationName: 

The application name, can be used instead of application_id

callSessionHistoryCustomData

Copy URL
var callSessionHistoryCustomData: 

To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter

callSessionHistoryId

Copy URL
var callSessionHistoryId: 

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

descOrder

Copy URL
var descOrder: 

Whether to get records in the descent order

fromDate

Copy URL
var fromDate: 

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

localNumber

Copy URL
var localNumber: 

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

output

Copy URL
var output: 

The output format. The following values available: csv.

remoteNumber

Copy URL
var remoteNumber: 

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

ruleName

Copy URL
var ruleName: 

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

timezone

Copy URL
var timezone: 

toDate

Copy URL
var toDate: 

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

withHeader

Copy URL
var withHeader: 

Whether to get a CSV file with the column names if the output=csv