Rate this page:

GetCallHistoryRequest

Props

applicationId

Copy URL
applicationId: 

number

|

undefined

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

applicationName

Copy URL
applicationName: 

string

|

undefined

The application name, can be used instead of application_id

callSessionHistoryCustomData

Copy URL
callSessionHistoryCustomData: 

string

|

undefined

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

callSessionHistoryId

Copy URL
callSessionHistoryId: 

any

|

number

|

number[]

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
childAccountId: 

any

|

number

|

number[]

The child account ID list separated by semicolons (;)

childrenCallsOnly

Copy URL
childrenCallsOnly: 

false

|

undefined

|

true

Whether to get the children account calls only

count

Copy URL
count: 

number

|

undefined

The number of returning records. In the synchronous mode, the maximum value is 1000

descOrder

Copy URL
descOrder: 

false

|

undefined

|

true

Whether to get records in the descent order

fromDate

Copy URL
fromDate: 

Date

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

isAsync

Copy URL
isAsync: 

false

|

undefined

|

true

Whether to get records in the asynchronous mode (for csv output only). Use this mode to download large amounts of data. See the , functions for details

localNumber

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

offset

Copy URL
offset: 

number

|

undefined

The number of records to skip in the output with a maximum value of 10000

output

Copy URL
output: 

string

|

undefined

The output format. The following values available: json, csv

remoteNumber

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

Copy URL
ruleName: 

string

|

undefined

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
timezone: 

string

|

undefined

toDate

Copy URL
toDate: 

Date

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

userId

Copy URL
userId: 

any

|

number

|

number[]

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
withCalls: 

false

|

undefined

|

true

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

withHeader

Copy URL
withHeader: 

false

|

undefined

|

true

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

withOtherResources

Copy URL
withOtherResources: 

false

|

undefined

|

true

Whether to get other resources usage (see )

withRecords

Copy URL
withRecords: 

false

|

undefined

|

true

Whether to get the calls' records

withTotalCount

Copy URL
withTotalCount: 

false

|

undefined

|

true

Whether to include the 'total_count' and increase performance