GetCallHistoryRequest
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 (;). The maximum number of records is 1000. 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
childAccountId: number
| number[]
| any
The child account ID list separated by semicolons (;)
childrenCallsOnly: boolean
Whether to get the children account calls only
count: number
The number of returning records. The maximum value is 1000
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. If both dates are omitted, a server-configured default interval is used (default is one month)
isAsync: boolean
Whether to create an asynchronous history report instead of returning the data immediately. Has the same effect as calling GetCallHistoryAsync and requires the output=csv
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
maxDuration: number
The maximum call duration in seconds to filter. You can restrict the allowed date range via duration filters
minDuration: number
The minimum call duration in seconds to filter. You can restrict the allowed date range via duration filters
offset: number
The number of records to skip in the output. The maximum value of 10000
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. Ignored if the remote_number_list parameter is not empty
remoteNumberList: string
A JSON array of strings of specific remote phone numbers to sort the call history. Has higher priority than the remote_number parameter. If the array is empty, the remote_number parameter is used instead
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. If both dates are omitted, a server-configured default interval is used (default is one month)
userId: number
| number[]
| any
To receive the call history for a specific users, pass the user ID list separated by semicolons (;). If it is specified, the output contains the calls from the listed users only
withCalls: boolean
Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information
withHeader: boolean
Whether to get a CSV file with the column names if the output=csv
withOtherResources: boolean
Whether to get other resources usage (see )
withRecords: boolean
Whether to get the calls' records
withTotalCount: boolean
Whether to include the 'total_count' and increase performance