Skip to Content

Download a Call Report

Download a specific call report.

Steps to download a call report

  1. Get the download URL of a call report
  2. Download the call report

Request URL

GET {base_url}/{api_path}/call_report/download?access_token={access_token}

Note: To enhance system performance, Cloud One has upgraded the CDR module in version 83.21.0.117 with a new data structure for clearer display and more comprehensive call details. The system gradually deletes old CDRs and related call report data according to the CDR Auto Cleanup setting.

Before old call report data are cleaned up, new and historical data are managed separately - openapi/v2.0 for new data and openapi/v1.0 for historical data. Make sure to use the appropriate API path based on the type of data that you want to retrieve.

Request parameters

ParameterAvailableRequiredTypeDescription
type

This parameter is available in default reports.

YesStringCall report type.
Valid value:
  • extcallstatistics: Extension Call Statistics report.
  • extcallactivity: Extension Call Activity report.
  • trunkactivity: PBX Call Activity report.
  • trunkdiddodactivity: DID/Outbound Caller ID Activity report.
  • ivr: IVR Report.
  • aisttusage: Transcription Usage Details report.
  • aireceptionistcallactivity: AI Receptionist Call Activity report.
  • Note:This report is only available in API version 2.0.
  • unreturnmisscall: Unreturned Missed Call Report.
  • queueavgwaittalktime: Queue AVG Waiting & Talking Time report.
  • queueperformance: Queue Performance report.
  • queueperformanceactivity: Queue Performance Activity report.
  • queuecallbackssummary: Queue Callback Summary report.
  • queuecallbacksactivity: Queue Callback Activity report.
  • queuesatisfaction: Satisfaction Survey report.
  • queuesatisfactiondetail: Queue Satisfaction Survey Details report.
  • queueagentlogintime: Agent Login Activity report.
  • queueagentpausetime: Agent Pause Activity report.
  • queueagentmisscalls: Agent Missed Call Activity report.
  • queueagentperformance: Agent Performance report.
  • queueagentinoutcalls: Agent Call Summary report.
  • ringgroupstatistics: Ring Group Statistics report.
  • extcallbilling: Extension Call Accounting report.
  • extcallbillingdetails: Extension Call Accounting Details report.
my_report_id

This parameter is available in user-created reports.

YesInteger

The ID of a user-created report.

Note: You can query report ID using Query My Reports List.
start_timeThis parameter is available when querying the following types of reports.
  • Extension Call Statistics
  • IVR Report
  • Transcription Usage Details
  • Unreturned Missed Call Report
  • Queue Performance
  • Queue Callback Summary
  • Queue Callback Activity
  • Satisfaction Survey
  • Satisfaction Survey Details
  • Agent Login Activity
  • Agent Pause Activity
  • Agent Missed Call Activity
  • Agent Performance
  • Agent Call Summary
  • Ring Group Statistics
  • Extension Call Accounting
  • Extension Call Accounting Details
  • Inbound Queue Activity Analysis
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
  • Agent Activity Analysis
NoStringSpecify the start time to filter the reports.
Note: The time format depends on the date and time display format of PBX (set in System > Date and Time > Display Format on PBX).

Examples:

  • If the display format is Month/Day/Year and is 24-hours format, then the valid time format is MM/DD/YYYY HH:mm:ss.
  • If the display format is Year/Month/Day and is 12-hours format, then the valid time format is YYYY/MM/DD HH:mm:ss AM or YYYY/MM/DD HH:mm:ss PM.
end_timeThis parameter is available when querying the following types of reports.
  • Extension Call Statistics
  • IVR Report
  • Transcription Usage Details
  • Unreturned Missed Call Report
  • Queue Performance
  • Queue Callback Summary
  • Queue Callback Activity
  • Satisfaction Survey
  • Satisfaction Survey Details
  • Agent Login Activity
  • Agent Pause Activity
  • Agent Missed Call Activity
  • Agent Performance
  • Agent Call Summary
  • Ring Group Statistics
  • Extension Call Accounting
  • Extension Call Accounting Details
  • Inbound Queue Activity Analysis
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
  • Agent Activity Analysis
NoStringSpecify the end time to filter the reports.
Note: The time format depends on the date and time display format of PBX (set in System > Date and Time > Display Format on PBX).

Examples:

  • If the display format is Month/Day/Year and is 24-hours format, then the valid time format is MM/DD/YYYY HH:mm:ss.
  • If the display format is Year/Month/Day and is 12-hours format, then the valid time format is YYYY/MM/DD HH:mm:ss AM or YYYY/MM/DD HH:mm:ss PM.
timeThis parameter is available when querying the following types of reports:
  • Extension Call Activity
  • PBX Call Activity
  • DID/Outbound Caller ID Activity
  • AI Receptionist Call Activity
  • Queue AVG Waiting & Talking Time
  • Queue Performance Activity
  • Inbound Queue Activity Analysis
  • Agent Activity Analysis
YesString

Specify the time frame to filter the call report.

Note: The time format depends on the date display format of PBX.

For example, Date Display Format of PBX is Year/Month/Day, then the valid time format is YYYY/MM/DD.

Time format:
  • To query the reports by hour, enter YYYY/MM/DD.
  • To query the reports by day, enter YYYY/MM.
  • To query the reports by month, enter YYYY.
ring_duration_rangeThis parameter is available when querying Inbound Queue Activity Analysis report.This parameter is available when querying Inbound Queue Activity Analysis report.StringSpecify the time interval used to group the amount of time that callers waited in the queue before connecting to an agent.

Valid value:

  • per_30s
  • per_60s
  • per_5m
  • per_10m
ext_id_listThis parameter is available when querying the following types of reports:
  • Extension Call Statistics
  • Extension Call Activity
  • Extension Call Accounting
  • Extension Call Accounting Details
This parameter is required when querying the following types of reports:
  • Extension Call Statistics
  • Extension Call Activity
StringThe ID(s) of the desired extension(s)/extension group(s).Note:
  • You can query the extension/extension group's ID using Get Menu Options.
  • Use a comma to separate multiple IDs.
trunk_idThis parameter is available when querying DID/Outbound Caller ID Activity report.YesStringThe ID of the desired trunk.
Note: You can query the trunk's ID using Get Menu Options.
trunk_id_listThis parameter is available when querying the following types of reports:
  • PBX Call Activity
  • Extension Call Accounting
  • Extension Call Accounting Details
YesStringThe ID(s) of the desired trunk(s).Note:
  • You can query the trunk's ID using Get Menu Options.
  • Use a comma to separate multiple IDs.
ivr_id_listThis parameter is available when querying IVR Report.YesStringThe ID(s) of the desired IVR(s).
Note:
  • You can query the IVR's ID using Get Menu Options.
  • Use a comma to separate multiple IDs.
ring_group_id_listThis parameter is available when querying Ring Group Statistics report.YesStringThe ID(s) of the desired ring group(s).
Note:
  • You can query the ring group's ID using Get Menu Options.
  • Use a comma to separate multiple IDs.
queue_idThis parameter is available when querying the following types of reports:
  • Satisfaction Survey
  • Satisfaction Survey Details
  • Agent Login Activity
  • Agent Pause Activity
  • Agent Missed Call Activity
  • Agent Performance
  • Agent Call Summary
YesStringThe ID of the desired queue.
Note: You can query the queue's ID using Get Menu Options.
queue_id_listThis parameter is available when querying the following types of reports:
  • Queue AVG Waiting & Talking Time
  • Queue Performance
  • Queue Performance Activity
  • Queue Callback Summary
  • Queue Callback Activity
  • Inbound Queue Activity Analysis
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
  • Agent Activity Analysis
YesStringThe ID(s) of the desired queue(s).
Note:
  • You can query the queue's ID using Get Menu Options.
  • Use a comma to separate multiple IDs.
agent_id_listThis parameter is available when querying the following types of reports:
  • Satisfaction Survey Details
  • Agent Login Activity
  • Agent Pause Activity
  • Agent Missed Call Activity
  • Agent Performance
  • Agent Call Summary
  • Inbound Queue Logs for Agent
  • Agent Activity Analysis
NoStringThe ID(s) of the desired agent(s).
Note:
  • You can query the agent's ID using Get Menu Options.
  • Use a comma to separate multiple IDs.
abandon_timeThis parameter is available when querying the following types of reports:
  • Unreturned Missed Call Report
  • Queue Performance
  • Queue Performance Activity
  • Agent Missed Call Activity
  • Agent Performance
  • Inbound Queue Activity Analysis
  • Agent Activity Analysis
NoStringSet a time. Calls abandoned within the specified time will not be included in report. (Unit: Second)
talk_timeThis parameter is available when querying the following types of reports:
  • Queue Performance
  • Inbound Queue Activity Analysis
  • Inbound Queue Logs
  • Agent Activity Analysis
NoIntegerSet a time. Calls that proceeded within the specified time will be not be included in report. (Unit: Second)
include_internalThis parameter is available when querying PBX Call Activity report.NoIntegerWhether to include internal calls in the report.
Valid value:
  • 0: Exclude the internal calls.
  • 1: Include the internal calls.
callback_resultThis parameter is available when querying Queue Callback Activity report.NoStringQueue callback result.

Valid value:

  • success
  • fail
reasonThis parameter is available when querying Agent Pause Activity report.NoStringThe reason why an agent switched status to pause.

Valid value: The pause reasons set on PBX web portal (Path: Call Features > Queue > Pause Reason).

communication_typeThis parameter is available when querying the following types of reports:
  • Extension Call Statistics
  • Extension Call Activity
  • PBX Call Activity
  • DID/Outbound Caller ID Activity
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
NoStringCommunication type.
Note: If this parameter is omitted, the system will query all the communication types.
Valid value for extension related reports:
  • Inbound
  • Outbound
  • Internal
  • InOutbound (for Extension Call Statistics report only)
Valid value for trunk related reports:
  • Inbound
  • Outbound
call_fromThis parameter is available when querying the following types of reports:
  • Unreturned Missed Call Report
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
NoStringThe number of the caller.
call_toThis parameter is available when querying the Unreturned Missed Call Report.NoStringThe number of the callee.
call_to_typeThis parameter is available when querying the Unreturned Missed Call Report.NoStringThe type of the destination to which the call is routed.
Valid value:
  • Extension
  • Queue
  • RingGroup
miss_call_typeThis parameter is available when querying the Unreturned Missed Call Report.NoString

The type of a missed call.

Valid value:
  • no_answer
  • busy
  • abandoned
unreturn_statusThis parameter is available when querying the Unreturned Missed Call Report.NoIntegerThe return status of a missed call.
Valid value:
  • 1: Returned.
  • 2: Not returned.
ai_receptionist_id_listThis parameter is available when querying the AI Receptionist Call Activity report.NoStringThe ID(s) of the AI receptionist(s).
Note:
  • You can query the ID using Get Menu Options (menu=ai_receptionist).
  • Use commas to separate multiple IDs.
statusThis parameter is available when querying the following types of reports:
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
NoStringThe status of a queue call.
Valid value:
  • ANSWERED
  • NO ANSWER
  • ABANDONED
agent_speed_to_answerThis parameter is available when querying the Inbound Queue Logs report.NoStringThe amount of time agents took to answer queue calls. (Unit: Second)
talk_time_rangeThis parameter is available when querying the following types of reports:
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
NoStringThe amount of time that agents spent talking to callers, including hold time. (Unit: Second)
pure_talk_timeThis parameter is available when querying the following types of reports:
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
NoStringThe amount of time that agents spent talking to callers, excluding hold time. (Unit: Second)
hold_timeThis parameter is available when querying the following types of reports:
  • Inbound Queue Logs
  • Inbound Queue Logs for Agent
NoStringThe amount of time that agents held queue calls. (Unit: Second)
agent_last_statusThis parameter is available when querying the Inbound Queue Logs for Agent report.NoStringThe last call status of agents.Valid value:
  • answered
  • abandoned
  • busy
  • no_answer
process_resultThis parameter is available when querying the Inbound Queue Logs for Agent report.NoStringThe process result for an abandoned or a missed queue call.
Valid value:
  • unprocessed
  • processing
  • processed
waiting_time_in_queueThis parameter is available when querying the Inbound Queue Logs for Agent report.NoStringThe amount of time callers waited in the queue before connecting to an agent or leaving. (Unit: Second)
waiting_time_in_agentThis parameter is available when querying the Inbound Queue Logs for Agent report.NoStringThe amount of time it took for agents to answer queue calls. (Unit: Second)
did_num_listThis parameter is available when querying the DID/Outbound Caller ID Activity report.NoStringThe DID number that caller dialed.
Note: Use commas to separate multiple DID numbers.
dod_num_listThis parameter is available when querying the DID/Outbound Caller ID Activity report.NoStringThe DOD number that caller dialed.
Note: Use commas to separate multiple DOD numbers.
pin_listThis parameter is available when querying the Extension Call Accounting Details report.NoStringThe PIN code used when making a call via a restricted outbound route.
Note: Use commas to separate multiple PIN codes.
need_detailThis parameter is available when querying the following types of reports:
  • IVR Report
  • Queue Performance
  • Queue Performance Activity
  • Agent Performance
  • Unreturned Missed Call Report
  • AI Receptionist Call Activity
NoIntegerWhether to include details about the associated calls.
Valid value:
  • 0: Exclude the call details.
  • 1: Include the call details.
detail_typeThis parameter is available in all call report types.NoStringHow to display details about the associated calls.
Valid value:
  • same_list: Download report data as indented, offset rows within the same list.
  • diff_list: Download report data as multiple files/sheets.
formatThis parameter is available in all call report types.NoStringThe download format.Valid value:
  • csv
  • xls
  • pdf
  • html
duration_formatThis parameter is available in all call report types.NoStringThe display format for all duration-related fields.

Valid value:

  • seconds
  • hhmmss
is_asyncThis parameter is available in all call report types.NoInteger

Whether to retrieve data and obtain the download URL of call report asynchronously.

Valid value:
  • 0: Synchronously.
  • 1: Asynchronously.
  • Note: When data is retrieved and the download URL of call report is generated, the PBX will send event report 30027 to the third-party application.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
  • You can check the error code and error message in Error Code and Error Message.
  • If you choose to retrieve data asynchronously, error code 2 and error message PROCESSING will be returned. 
Note: When data is retrieved and the download URL of call report is generated, the PBX will send event report 30027 to the third-party application.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
fileStringThe call report file.
download_resource_urlStringThe call report download URL.
Note: The download URL is only valid for 30 minutes.

Examples

Request example

Obtain the download URL of the IVR report (IVR ID: "1") during 2025/12/01 00:00:00 - 2025/12/31 23:59:59.

Important:

  • If you want to filter call reports by date and time, the format of start_time and end_time MUST follow the date and time display format of your PBX, otherwise the response will not return any records.

  • Make sure to use the appropriate API path based on the type of report data that you want to retrieve.

    • For new report data generated on version 83.21.0.117 or later, use openapi/v2.0.
    • For legacy report data generated on version 83.21.0.66 or earlier, use openapi/v1.0.
GET openapi/v2.0/call_report/download?access_token=5qcixSatPqNQfjsepgFdUsQBID1ZWnu8&type=ivr&start_time=2025/12/01 00:00:00&end_time=2025/12/31 23:59:59&ivr_id_list=1&need_detail=1&is_async=0&detail_type=same_list&format=pdf&duration_format=seconds HTTP/1.1  
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "QueueSatisfaction-X.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv",
    "download_resource_url": "/api/download/QueueSatisfaction-x.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv"
}

Download the call report

After obtaining the download URL for the call report, combine it with the {base_url} and append the {access_token} parameter. Then, use the complete link to download the call reports.

Download link format

{base_url}/{download_resource_url}?access_token={access_token}

Download link example

https://192.168.5.150:8088/api/download/QueueSatisfaction-x.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv?access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr