Rate this page:

History

Methods

[POST]

exportCallsHistoryReport

Copy URL

Start processing the call history report. To check if the processing is over, use the getReportStatus method; use the downloadReport method to get the download link.

exportCallsHistoryReport example

exportCallsHistoryReport example

Start processing the call history report. To check if the processing is over, use the getReportStatus method; use the downloadReport method to get the download link.

Parameters

  • domain:

    string

    Your account name

  • access_token:

    string

    Your api token

  • datetime_start:

    string

    Start date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’ in UTC

  • datetime_end:

    string

    End date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’ in UTC

  • call_direction:

    string

    Call direction (example: ‘call_direction=outgoing’ or ‘call_direction=incoming’ or ‘call_direction=all’)

  • scenario_ids:

    string

    Json integer array with scenarios IDs. The ID can be retrieved via the searchScenarios method. (example: scenario_ids=[1,2,3,…,9])

  • campaign_ids:

    string

    Json integer array with campaign IDs. The ID can be retrieved via the searchCampaigns method. (example: campaign_ids=[1,2,3,…,9])

  • phone:

    string

    Phone number to filter. The response will include calls to the specified number only. The minimum number of digits is 3. (example: phone=15417543010)

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.

  • datetime_start:

    string

    Start date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’ in UTC

  • datetime_end:

    string

    End date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’ in UTC

  • call_direction:

    string

    Call direction (example: ‘call_direction=outgoing’ or ‘call_direction=incoming’ or ‘call_direction=all’)

  • scenario_ids:

    string

    Json integer array with scenarios IDs. The ID can be retrieved via the searchScenarios method. (example: scenario_ids=[1,2,3,…,9])

  • campaign_ids:

    string

    Json integer array with campaign IDs. The ID can be retrieved via the searchCampaigns method. (example: campaign_ids=[1,2,3,…,9])

  • 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)

  • domain:

    string

    Your account name

  • access_token:

    string

    Your api token

Returns