Rate this page:

GetBriefCallHistoryRequest

Props

applicationId

Optional
Copy URL
 applicationId

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

applicationName

Optional
Copy URL
 applicationName

The application name, can be used instead of application_id

callSessionHistoryCustomData

Optional
Copy URL
 callSessionHistoryCustomData

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

callSessionHistoryId

Optional
Copy URL
 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

Optional
Copy URL
 descOrder

Whether to get records in the descent order

fromDate

Copy URL
 fromDate

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

localNumber

Optional
Copy URL
 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
 output

The output format. The following values available: csv.

remoteNumber

Optional
Copy URL
 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

Optional
Copy URL
 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

Optional
Copy URL
 timezone

toDate

Copy URL
 toDate

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

withHeader

Optional
Copy URL
 withHeader

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