Rate this page:

Calls

Methods

[POST]

downloadHistoryReport

Copy URL

Get the download link to the call history file (.xsls).

downloadHistoryReport example

downloadHistoryReport example

Get the download link to the call history file (.xsls).

Parameters

  • report_id:

    integer

    Optional

    Report ID. The ID can be retrieved via the exportHistoryReport method

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

  • 200:

    Link to the call history file is successfully retrieved

  • default:

    ErrorType

    Command execution error

[POST]

exportHistoryReport

Copy URL

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.

exportHistoryReport example

exportHistoryReport example

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

    Unique access token

Returns

[POST]

getHistoryReportStatus

Copy URL

Get info about call history processing. If the response parameter "processed" is True, the call history can be downloaded via the downloadHistoryReport method.

getHistoryReportStatus example

getHistoryReportStatus example

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

    Optional

    Report ID. The ID can be retrieved via the exportHistoryReport method

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[GET]

searchCalls

Copy URL

Search for the calls. The method without specifying the parameters returns the last 20 calls.

searchCalls example

searchCalls example

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

    Unique access token

Returns