Rate this page:

GetCallHistoryAsyncRequest

Props

applicationId

Copy URL

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

applicationName

Copy URL

The application name, can be used instead of application_id

callSessionHistoryCustomData

Copy URL

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

callSessionHistoryId

Copy URL

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

childAccountId

Copy URL

The child account ID list separated by semicolons (;)

childrenCallsOnly

Copy URL

Whether to get the children account calls only

descOrder

Copy URL

Whether to get records in the descent order

fromDate

Copy URL

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

localNumber

Copy URL

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

The output format. The following values available: csv. The default value is csv

remoteNumber

Copy URL

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

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

toDate

Copy URL

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

userId

Copy URL

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

Copy URL

Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information

withHeader

Copy URL

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

withOtherResources

Copy URL

Whether to get other resources usage (see )

withRecords

Copy URL

Whether to get the calls' records