Calls
Methods
downloadHistoryReport
Method is deprecated. Download report file (.xlsx or .csv).
Parameters
report_id:
integer
Report ID. The ID can be retrieved via the exportHistoryReport method
domain:
string
Your account name
access_token:
string
Your api token
Returns
200:
Report file (.xlsx or .csv).
default:
Command execution error
exportHistoryReport
Method is deprecated. Start processing the call history. To check if the processing is over, use the getHistoryReportStatus method; use the downloadHistoryReport method to get the download link.
Parameters
call_direction:
string
Call direction (example: ‘call_direction=outgoing’ or ‘call_direction=incoming’ or ‘call_direction=all’)
scenario_id:
integer
Scenario ID. The ID can be retrieved via the searchScenarios method.
from:
string
Start date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’
to:
string
End date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’
domain:
string
Your account name
access_token:
string
Your api token
Returns
Processing the call history is successfully started
default:
Command execution error
getHistoryReportStatus
Method is deprecated. Get info about call history processing. If the response parameter "processed" is True, the call history can be downloaded via the downloadHistoryReport method.
Parameters
report_id:
integer
Report ID. The ID can be retrieved via the exportHistoryReport method
domain:
string
Your account name
access_token:
string
Your api token
Returns
Call history report status is successfully retrieved
default:
Command execution error
searchCalls
Method is deprecated. Search for the calls. The method without specifying the parameters returns the last 20 calls.
Parameters
id:
integer
Call ID.
call_direction:
string
Call direction (example: ‘call_direction=outgoing’ or ‘call_direction=incoming’ or ‘call_direction=all’)
scenario_id:
integer
Scenario ID. The ID can be retrieved via the searchScenarios method
phone:
integer
Phone number to filter. The response will include calls to the specified number only. The minimum number of digits is 3. (example: phone=15417543010)
datetime_start:
string
Start date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’
datetime_end:
string
End date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’
domain:
string
Your account name
access_token:
string
Your api token
Returns
Search request is successfully performed
default:
Command execution error