Query Call Report List
Query call statistics of different objects, such as extensions, trunk, queues, ring groups, etc.
Request URL
GET {base_url}/{api_path}/call_report/list?access_token={access_token}
Request parameters
Parameter | Available | Required | Type | Description |
---|---|---|---|---|
type | This parameter is available in all call report types. | Yes | String | Call report type. Valid value:
|
start_time | This parameter is available when querying the following types
of reports.
|
No | String | Specify the start time to filter the reports. Note: The time format depends on the
date and time display format of PBX (set in on PBX).
Examples:
|
end_time | This parameter is available when querying the following types
of reports.
|
No | String | Specify the end time to filter the reports. Note: The time format depends on the
date and time display format of PBX (set in on PBX).
Examples:
|
time | This parameter is available when querying the following types
of reports:
|
Yes | String |
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
Time format:
|
ext_id_list | This parameter is available when querying the following types
of reports:
|
This parameter is required when querying the following types
of reports:
|
String | The ID(s) of the desired extension(s)/extension
group(s). Note:
|
trunk_id | This parameter is available when querying DID/Outbound Caller ID Activity report. | Yes | String | The ID of the desired trunk. Note: You
can query the trunk's ID using Get Menu Options. |
trunk_id_list | This parameter is available when querying the following types
of reports:
|
Yes | String | The ID(s) of the desired trunk(s). Note:
|
ivr_id_list | This parameter is available when querying IVR Report. | Yes | String | The ID(s) of the desired IVR(s). Note:
|
ring_group_id_list | This parameter is available when querying Ring Group Statistics report. | Yes | String | The ID(s) of the desired ring group(s). Note:
|
queue_id | This parameter is available when querying the following types
of reports:
|
Yes | String | The ID of the desired queue. Note: You
can query the queue's ID using Get Menu Options. |
queue_id_list | This parameter is available when querying the following types
of reports:
|
Yes | String | The ID(s) of the desired queue(s). Note:
|
agent_id_list | This parameter is available when querying the following types
of reports:
|
No | String | The ID(s) of the desired agent(s). Note:
|
abandon_time | This parameter is available when querying the following types
of reports:
|
No | String | Set a time. Calls abandoned within the specified time will not be included in report. (Unit: Second) |
talk_time | This parameter is available when querying Queue Performance report. | No | Integer | Set a time. Calls that proceeded within the specified time will be not be included in report. (Unit: Second) |
include_internal | This parameter is available when querying PBX Call Activity report. | No | Integer | Whether to include internal calls in the report. Valid
value:
|
callback_result | This parameter is available when querying Queue Callback Activity report. | No | String | Queue callback result. Valid value:
|
reason | This parameter is available when querying Agent Pause Activity report. | No | String | The reason why an agent switched status to pause. Valid value: The pause reasons set on PBX web portal (Path: ). |
communication_type | This parameter is available when querying the following types
of reports:
|
No | String | Communication type. Note: If this
parameter is omitted, the system will query all the
communication types. Valid value for extension
related reports:
Valid value for trunk related reports:
|
Response parameters
Parameter | Type | Description |
---|---|---|
errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
errmsg | String | Returned message.
|
total_number | Integer | The total number of reports. |
is_12hour | Integer | Whether the time format is 12-hour format.
|
ext_call_statistics_list | Array<ext_call_statistics_list> | The list of the Extension Call Statistics reports. |
ext_call_activity_list | Array<ext_call_activity_list> | The list of the Extension Call Activity reports. |
trunk_activity_list | Array<trunk_activity_list> | The list of the PBX Call Activity reports. |
trunk_did_dod_activity_list | Array<trunk_did_dod_activity_list> | The list of the trunk DID/Outbound Caller ID Activity reports. |
ivr_list | Array<ivr_list> | The list of the IVR reports. |
queue_avg_wait_talk_time_list | Array<queue_avg_wait_talk_time_list> | The list of the Queue AVG Waiting & Talking Time reports. |
queue_performance_list | Array<queue_performance_list> | The list of the Queue Performance reports. |
queue_performance_activity_list | Array<queue_performance_activity_list> | The list of the Queue Performance Activity reports. |
queue_callbacks_summary_list | Array<queue_callbacks_summary_list> | The list of the Queue Callback Summary reports. |
queue_callbacks_activity_list | Array<queue_callbacks_activity_list> | The list of the Queue Callback Activity reports. |
queue_satisfaction | Array<queue_satisfaction> | The list of the queue Satisfaction Survey reports. |
queue_satisfaction_detail_list | Array<queue_satisfaction_detail_list> | The list of the queue Satisfaction Survey Details reports. |
queue_agent_login_time_list | Array<queue_agent_login_time_list> | The list of the queue Agent Login Activity reports. |
queue_agent_pause_time_list | Array<queue_agent_pause_time_list> | The list of the queue Agent Pause Activity reports. |
queue_agent_miss_calls_list | Array<queue_agent_miss_calls_list> | The list of the queue Agent Missed Call Activity reports. |
queue_agent_performance_list | Array<queue_agent_performance_list> | The list of the queue Agent Performance reports. |
queue_agent_in_out_calls_list | Array<queue_agent_in_out_calls_list> | The list of the queue Agent Call Summary reports. |
ring_group_statistics_list | Array<ring_group_statistics_list> | The list of the Ring Group Statistics reports. |
ext_call_billing_list | Array<ext_call_billing_list> | The list of the Extension Call Accounting reports. |
ext_call_billing_details_list | Array<ext_call_billing_details_list> | The list of the Extension Call Accounting Details reports. |
callback_result | String | Queue callback result. |
- ext_call_statistics_list
-
Parameter Type Description ext_num String Extension number. ext_name String Extension name. answered_calls Integer The total number of calls that the extension answered. no_answer_calls Integer The total number of calls that were routed to the designated destination when the extension didn't answer the calls. busy_calls Integer The total number of calls that were routed to the designated destination when the extension was busy. failed_calls Integer The total number of calls that were failed to be made by the extension. voicemail_calls Integer The total number of voicemails that the extension received. total_holding_time Integer The total time between calls started and calls answered. total_talking_time Integer The total time between calls answered and calls ended. - ext_call_activity_list
-
Parameter Type Description time Integer The time of the report. - If the report is filtered by Hour, the
time
returns the hour in the day.For example, if the time of the report is between 10:00-10:59, the
time
will be10
. - If the report is filtered by Day, the
time
returns the day in the month.For example, if the date of the report is Apr. 13, the
time
will be13
. - If the report is filtered by Month, the
time
returns the month in the year.For example, if the month of the report is April, the
time
will be4
.
answered_calls Integer The total number of calls that the extension answered. no_answer_calls Integer The total number of calls that were routed to the designated destination when the extension didn't answer the calls. busy_calls Integer The total number of calls that were routed to the designated destination when the extension was busy. failed_calls Integer The total number of calls that were failed to be made by the extension. voicemail_calls Integer The total number of voicemails that the extension received. total_holding_time Integer The total time between calls started and calls answered. total_talking_time Integer The total time between calls answered and calls ended. - If the report is filtered by Hour, the
- trunk_activity_list
-
Parameter Type Description time Integer The time of the report. - If the report is filtered by Hour, the
time
returns the hour in the day.For example, if the time of the report is between 10:00-10:59, the
time
will be10
. - If the report is filtered by Day, the
time
returns the day in the month.For example, if the date of the report is Apr. 13, the
time
will be13
. - If the report is filtered by Month, the
time
returns the month in the year.For example, if the month of the report is April, the
time
will be4
.
trunk_list Array<call_statistics> The data of PBX call activities. - If the report is filtered by Hour, the
- trunk_did_dod_activity_list
-
Parameter Type Description time Integer The time of the report. - If the report is filtered by Hour, the
time
returns the hour in the day.For example, if the time of the report is between 10:00-10:59, the
time
will be10
. - If the report is filtered by Day, the
time
returns the day in the month.For example, if the date of the report is Apr. 13, the
time
will be13
. - If the report is filtered by Month, the
time
returns the month in the year.For example, if the month of the report is April, the
time
will be4
.
did_dod_list Array<did_dod_list> The activity information of the trunk DID/Outbound caller ID. - If the report is filtered by Hour, the
- ivr_list
-
Parameter Type Description detail Array<ivr_call_detail> The list of IVR call details. ivr_name String IVR name. ivr_num String IVR number. press_count Object The keypress events in the IVR and their counts. This parameter returns the keypress events in the format
"press_keypress_event":count
.For example:- "press_0": 2
- "press_invalid": 1
- "press_timeout": 1
- queue_avg_wait_talk_time_list
-
Parameter Type Description time Integer The time of the report. - If the report is filtered by Hour, the
time
returns the hour in the day.For example, if the time of the report is between 10:00-10:59, the
time
will be10
. - If the report is filtered by Day, the
time
returns the day in the month.For example, if the date of the report is Apr. 13, the
time
will be13
. - If the report is filtered by Month, the
time
returns the month in the year.For example, if the month of the report is April, the
time
will be4
.
avg_wait_time Integer The average amount of time that the answered calls have been waiting in the queue before being answered by agents. Note: The value of this parameter is calculated by dividing theanswered_waiting_time
by the total number ofanswered_calls
. The calculation result is rounded down to the nearest whole number.avg_talk_time Integer The average amount of time that agents talk to callers. Note: The value of this parameter is calculated by dividing thetotal_talking_time
by the total number ofanswered_calls
. The calculation result is rounded down to the nearest whole number.all_call_avg_wait_time Integer The average amount of time that all incoming calls have been waiting in the queue, regardless of whether they are answered or not. Note: This parameter is calculated by dividing thetotal_waiting_time
by the number oftotal_calls
. The calculation result is rounded down to the nearest whole number.answered_calls Integer The number of calls that have been answered by agents. total_calls Integer The total number of calls that queue received. answered_waiting_time Integer The total waiting time of the answered calls. total_waiting_time Integer The total waiting time of all the incoming calls. total_talking_time Integer The total talking time of all the answered calls. - If the report is filtered by Hour, the
- queue_performance_list
-
Parameter Type Description queue String Queue name. total_calls Integer The total number of calls that queue received. answered_calls Integer The total number of calls that queue answered. missed_calls Integer The total number of calls that queue missed. abandoned_calls Integer The total number of calls that callers abandoned before connecting to an agent. average_waiting_time Integer The average amount of time that answered calls have been waiting in the queue before being answered by agents. average_talking_time Integer The average amount of time that agents talk to callers. max_waiting_time Integer The maximum amount of time that callers waited in the queue, regardless of whether the calls were answered or not. answered_rate number The percentage of answered calls in relation to the total received calls. missed_rate number The percentage of missed calls in relation to the total received calls. abandoned_rate number The percentage of abandoned calls in relation to the total received calls. sla number The Service Level Agreement (SLA) for the queue. SLA is the percentage of conversations answered within a pre-defined amount of time. average_handle_time Integer The average amount of time it takes agents to handle answered calls. Note: The value of this parameter is calculated by dividing the total amount of time between the start of ringing and the end of the answered calls by the total number of the answered calls.all_call_average_waiting_time Integer The average amount of time that all incoming calls have been waiting in the queue, regardless of whether they are answered or not. detail Array<queue_call_detail> The list of queue call details. answered_call_time Integer The total amount of talking time in answered calls. total_ring_time Integer The total amount of ringing time for all incoming calls. answered_hold_time Integer The total amount of time that agents hold calls in the answered queue calls. queue_num String Queue number.
- queue_performance_activity_list
-
Parameter Type Description id Integer The sequence number of the record. time Integer The time of the report. - If the report is filtered by Hour, the
time
returns the hour in the day.For example, if the time of the report is between 10:00-10:59, the
time
will be10
. - If the report is filtered by Day, the
time
returns the day in the month.For example, if the date of the report is Apr. 13, the
time
will be13
. - If the report is filtered by Month, the
time
returns the month in the year.For example, if the month of the report is April, the
time
will be4
.
total_calls Integer The total number of calls that queue received. answered_calls Integer The total number of calls that queue answered. missed_calls Integer The total number of calls that queue missed. abandoned_calls Integer The total number of calls that callers abandoned before connecting to an agent. average_waiting_time Integer The average amount of time that answered calls have been waiting in the queue before being answered by agents. max_waiting_time Integer The maximum amount of time that callers waited in the queue, regardless of whether the calls were answered or not. answered_rate number The percentage of answered calls in relation to the total received calls. missed_rate number The percentage of missed calls in relation to the total received calls. abandoned_rate number The percentage of abandoned calls in relation to the total received calls. sla number The Service Level Agreement (SLA) for the queue. SLA is the percentage of conversations answered within a pre-defined amount of time. sla_calls Integer The number of calls that were answered within the SLA time. total_waiting_time Integer The total waiting time of all the incoming calls. average_handle_time Integer The average amount of time it takes agents to handle answered calls. Note: The value of this parameter is calculated by dividing the total amount of time between the start of ringing and the end of the answered calls by the total number of the answered calls.all_call_average_waiting_time Integer The average amount of time that all incoming calls have been waiting in the queue, regardless of whether they are answered or not. average_talking_time Integer The average amount of time that agents talk to callers. average_hold_time Integer The average amount of time that agents hold calls in the answered queue calls. detail Array<queue_call_detail> The list of the queue call details. answered_waiting_time Integer The total waiting time of the answered calls. answered_call_time Integer The total amount of talking time in answered calls. answered_hold_time Integer The total amount of time that agents hold calls in the answered queue calls. total_talk_time Integer The total time between calls answered and calls ended. - If the report is filtered by Hour, the
- queue_callbacks_summary_list
-
Parameter Type Description id Integer The item number of the returned records. queue String The queue number. failed_callback Integer The number of failed callbacks. succ_callback Integer The number of successful callbacks. request_callback Integer The total number of callbacks for which callers requested successfully. total_received Integer The total number of calls that the queue received.
- queue_callbacks_activity_list
-
Parameter Type Description id Integer The item number of the returned records. time String The time that the caller called to the queue. call_from String The caller's caller ID. callback_time String The time that the system performed the callback. call_back_number String The callback number that the caller registered. waiting_time Integer The time between the call started and the callback answered. callback_result String Whether the callback is successful or not. failed_reason String The reason why the queue failed to make the callback.
- queue_satisfaction
-
Parameter Type Description queue_name String The queue name. queue_num String The queue number. satisfaction_list Array<satisfaction_list> The satisfaction details list. agent_list Array<agent_list> The agent list of the queue.
- queue_satisfaction_detail_list
-
Parameter Type Description id Integer The item number of the returned records. agent_num String Agent number. agent_name String Agent name. time String The time when the call was received. call_from String The number and name of the caller. key String The key pressed by the caller. point Integer The corresponding score for the pressed key.
- queue_agent_login_time_list
-
Parameter Type Description agent_name String Agent name. agent_number String Agent number. login String The date and time that an agent logged in to a queue. logout String The date and time that an agent logged out of a queue. total_login_time Integer The elapsed time between the login time and the logout time. (Unit: Second) - queue_agent_pause_time_list
-
Parameter Type Description agent_name String Agent name. agent_number String Agent number. pause String The date and time that an agent changed status to pause. unpause String The date and time that an agent changed status to unpause. total_pause_time Integer The elapsed time between the paused time and the unpaused time. (Unit: Second) total_pause Integer The total number of times that agent paused services, excluding changing pause reason. - queue_agent_miss_calls_list
-
Parameter Type Description agent_name String Agent name. agent_num String Agent number. time String The date and time that the caller called to the queue.
total_wait_time Integer The total waiting time of the incoming calls. (Unit: Second) src_name String The caller's caller ID name. src_num String The caller's caller ID. queue_status String The final status of missed calls, indicating whether the missed calls were answered by other agents in the queue. polling_attempts Integer The number of polling attempts to call an agent. calls Integer The number of the missed calls which indicate that this is a missed call, and the value is fixed at 1. - queue_agent_performance_list
-
Parameter Type Description queue String Queue name. total_calls Integer The total number of calls that queue received. answered_calls Integer The total number of calls that queue answered. missed_calls Integer The total number of calls that queue missed. abandoned_calls Integer The total number of calls that callers abandoned before connecting to an agent. average_waiting_time Integer The average amount of time that answered calls have been waiting in the queue before being answered by agents. average_talking_time Integer The average amount of time that agents talk to callers. max_waiting_time Integer The maximum amount of time that callers waited in the queue, regardless of whether the calls were answered or not. answered_rate number The percentage of answered calls in relation to the total received calls. missed_rate number The percentage of missed calls in relation to the total received calls. abandoned_rate number The percentage of abandoned calls in relation to the total received calls. sla number The Service Level Agreement (SLA) for the queue. SLA is the percentage of conversations answered within a pre-defined amount of time. answered_waiting_time Integer The total waiting time of the answered calls. total_talking_time Integer The total talking time of all the answered calls. average_handle_time Integer The average amount of time it takes agents to handle answered calls. Note: The value of this parameter is calculated by dividing the total amount of time between the start of ringing and the end of the answered calls by the total number of the answered calls.all_call_average_waiting_time Integer The average amount of time that all incoming calls have been waiting in the queue, regardless of whether they are answered or not. answered_hold_time Integer The total amount of time that agents hold calls in the answered queue calls. answered_call_time Integer The total amount of talking time in answered calls. total_waiting_time Integer The total waiting time of all the incoming calls. answered_hold_time Integer The total amount of time that agents hold calls in the answered queue calls. detail Array<agent_performance_detail> The list of agent performance details. queue_num String Queue number. - queue_agent_in_out_calls_list
-
Parameter Type Description agent_name String Agent name. agent_num String Agent number. inbound_calls Integer The number of incoming calls received by an agent. inbound_duration Integer The amount of time an agent spent in incoming calls. outbound_calls Integer The number of outgoing calls placed by an agent. outbound_duration Integer The amount of time an agent spent in outgoing calls. total_calls Integer The total number of incoming calls and outgoing calls handled by an agent. total_duration Integer The total amount of time an agent spent in incoming calls and outgoing calls. average_talk_duration Integer The average amount of time that agents talk to callers. average_handle_duration Integer The average amount of time it takes agents to handle answered calls. Note: The value of this parameter is calculated by dividing the total amount of time between the start of ringing and the end of the answered calls by the total number of the answered calls.average_waiting_duration Integer The average amount of time that it takes for an incoming call to be distributed to an agent. average_hold_duration Integer The average amount of time that agents held calls in the answered queue calls.
- ring_group_statistics_list
-
Parameter Type Description group_name String Ring group name. group_num String Ring group number. answered_calls Integer The number of calls the ring group answered. total_calls Integer The total number of calls the ring group received. member_list Array<member_list> The information of the members in the ring group. - ext_call_billing_list
-
Parameter Type Description id Integer The item number of the returned records. extension String The extension number and extension name of the user who made outbound calls. total_call Integer The total number of outbound calls made where a call rate rule is applied. total_talk_duration Integer The total time between calls answered and calls ended. average_talk_duration Integer The average time between calls answered and calls ended. amount number The call cost. - ext_call_billing_details_list
-
Parameter Type Description id Integer The item number of the returned records. extension String The number and name of the extension user who made outbound calls. time String When the outbound call was made. call_to String The callee number. talk_duration Integer The total time between calls answered and calls ended. amount number The call cost.
Examples
Request example
Query the inbound call statistics of the extensions in an extension group (ID:"34") during 2022/04/01 12:00:00 AM-2022/04/15 11:59:59 PM.
start_time
and
end_time
MUST follow the date and
time display format of your PBX, otherwise the response will not
return any records.GET /openapi/v1.0/call_report/list?type=extcallstatistics&start_time=2022/04/01 12:00:00 AM&end_time=2022/04/15 11:59:59 PM&ext_id_list=34&access_token=yzp2Ty69tJTZxKtoYWMZOyvmrcbDKm5S&communication_type=Inbound HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
Response example
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 2,
"ext_call_statistics_list": [
{
"ext_num": "2002",
"ext_name": "Terrell Smith",
"answered_calls": 40,
"no_answer_calls": 10,
"busy_calls": 3,
"failed_calls": 0,
"voicemail_calls": 7,
"total_holding_time": 472,
"total_talking_time": 588
},
{
"ext_num": "2005",
"ext_name": "Kristin Hale",
"answered_calls": 16,
"no_answer_calls": 0,
"busy_calls": 0,
"failed_calls": 0,
"voicemail_calls": 0,
"total_holding_time": 111,
"total_talking_time": 141
}
]
}