switchvox.callQueueReports.search

From SwitchvoxExtendAPI

1 Description
2 Arguments
- 2.1 Request
3 Example Request (By Queue)
- 3.1 Response
4 Example Response (By Queue)
- 4.1 Response
5 Example Response (By Day)
- 5.1 Response
6 Example Response (By Day Of Week)
- 6.1 Response
7 Example Response (By Hour Of Day)
- 7.1 Response
8 Example Response (By Talk Duration)
- 8.1 Response
9 Example Response (By Wait Duration)
- 9.1 Error Codes

Description

Returns a call queue report based on the criteria provided.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.

Name Required Type Default Description

start_date required date Minimum start time of the call. Calls with a start time greater than or equal to this value will be returned. The date should be in the format YYYY-MM-DD HH:MM:SS.

end_date required date Maximum start time of the call. Calls with a start time less than or equal to this value will be returned. The date should be in the format YYYY-MM-DD HH:MM:SS. This value should be greater than the start_date.

ignore_weekends optional boolean 0 Flag to ignore weekends or not. Set to 1 to ignore weekends or 0 to include weekends in your report.

queue_account_ids
queue_account_id at least one required integer A list of call queue account ids.

breakdown optional string by_queue The report breakdown. Possible values: by_queue, by_day, by_hour_of_day, by_day_of_week, by_talk_duration and by_wait_duration.

report_fields
report_field at least one required string A list of the fields to report. Possible values: total_calls, completed_calls, abandoned_calls, redirected_calls, longest_queue_length, avg_entry_position, max_wait_time_all_calls, avg_wait_time_all_calls, max_wait_time_completed_calls, avg_wait_time_completed_calls, max_wait_time_abandoned_calls, avg_wait_time_abandoned_calls, max_wait_time_redirected_calls, avg_wait_time_redirected_calls, max_talk_time and avg_talk_time.

format optional string xml Format of the report. Possible values: xml (no excel support yet)

sort_field optional string total_calls The field on which to sort the returned report. Possible values: account_id, date, day, hour, range_start, range_end, total_calls, completed_calls, abandoned_calls, redirected_calls, longest_queue_length, avg_entry_position, max_wait_time_all_calls, avg_wait_time_all_calls, max_wait_time_completed_calls, avg_wait_time_completed_calls, max_wait_time_abandoned_calls, avg_wait_time_abandoned_calls, max_wait_time_redirected_calls, avg_wait_time_redirected_calls, max_talk_time and avg_talk_time.

sort_order optional string ASC The order in which to sort returned call log entries. Possible values: ASC and DESC.

items_per_page optional integer 50 Number of records to return per page.

page_number optional integer 1 The page number of the results to return.

Request

Example Request (By Queue)

Please see the API Request Formats section for more information on various request encodings.

<?xml version="1.0"?>
<request method="switchvox.callQueueReports.search">
 <parameters>
 <start_date>2010年05月01日 00:00:00</start_date>
 <end_date>2010年06月30日 00:00:00</end_date>
 <ignore_weekends>1</ignore_weekends>
 <queue_account_ids>
 <queue_account_id>1113</queue_account_id>
 <queue_account_id>1114</queue_account_id>
 <queue_account_id>1115</queue_account_id>
 </queue_account_ids>
 <breakdown>by_queue</breakdown>
 <report_fields>
 <report_field>total_calls</report_field>
 <report_field>completed_calls</report_field>
 <report_field>abandoned_calls</report_field>
 <report_field>redirected_calls</report_field>
 <report_field>longest_queue_length</report_field>
 <report_field>avg_entry_position</report_field>
 <report_field>max_wait_time_all_calls</report_field>
 <report_field>avg_wait_time_all_calls</report_field>
 <report_field>max_wait_time_completed_calls</report_field>
 <report_field>avg_wait_time_completed_calls</report_field>
 <report_field>max_wait_time_abandoned_calls</report_field>
 <report_field>avg_wait_time_abandoned_calls</report_field>
 <report_field>max_wait_time_redirected_calls</report_field>
 <report_field>avg_wait_time_redirected_calls</report_field>
 <report_field>max_talk_time</report_field>
 <report_field>avg_talk_time</report_field>
 </report_fields>
 <format>xml</format>
 <sort_field>account_id</sort_field>
 <sort_order>asc</sort_order>
 <items_per_page>50</items_per_page>
 <page_number>1</page_number>
 </parameters>
</request>