GetBriefCallHistoryRequest
Props
applicationId: number
To receive the call history for a specific application, pass the application ID to this parameter
applicationName: string
The application name, can be used instead of application_id
callSessionHistoryCustomData: string
To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter
callSessionHistoryId: number
| number[]
| any
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: boolean
Whether to get records in the descent order
fromDate: Date
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
localNumber: string
| string[]
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: string
The output format. The following values available: csv.
remoteNumber: string
| string[]
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: string
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: string
toDate: Date
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
withHeader: boolean
Whether to get a CSV file with the column names if the output=csv