switchvox.callQueueLogs.search
From SwitchvoxExtendAPI
Contents |
Description
Returns a call queue log 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 1 account ID required integer A list of call queue account ids.
queue_account_id at least 1 account ID required integer A list of call queue account ids.
call_types
call_type at least 1 call type required string A list of queue call types. Valid values are: completed_calls, abandoned_calls and redirected_calls.
call_type at least 1 call type required string A list of queue call types. Valid values are: completed_calls, abandoned_calls and redirected_calls.
format
optional
string
xml
Format of the log. Possible values: xml. (no support for excel yet)
sort_field
optional
string
start_time
The field on which to sort the returned report. Possible values: start_time, type, queue_account_id, caller_id_number, wait_time, talk_time, member_account_id and enter_position, exit_position, and abandon_position.
sort_order
optional
string
ASC
The order in which to sort returned queue 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.
Example Requests & Responses
- Please see the API Request and Response Format section for more information on various request encodings.
Example One
Request
Request all the call queue logs for accounts 1113 (extension 301) and 1114 (extension 302) between June 1st and June 2nd of 2010. Also ignore weekend calls and report completed/abandoned/redirected calls.
<?xml version="1.0"?> <request method="switchvox.callQueueLogs.search"> <parameters> <start_date>2010年06月01日 00:00:00</start_date> <end_date>2010年06月02日 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_ids> <call_types> <call_type>completed_calls</call_type> <call_type>abandoned_calls</call_type> <call_type>redirected_calls</call_type> </call_types> <format>xml</format> <sort_field>start_time</sort_field> <sort_order>ASC</sort_order> <items_per_page>50</items_per_page> <page_number>1</page_number> </parameters> </request>
Response
<response method="switchvox.callQueueLogs.search"> <result> <calls page_number="1" total_pages="1" items_per_page="50" total_items="3"> <call start_time="2010年06月01日 15:10:42" type="abandoned" queue_account_id="1113" queue_name="Sales" queue_extension="355" caller_id_number="421" caller_id_name="Jon Doe" origination="outgoing" wait_time="4" enter_position="1" abandon_position="1" member_misses="2" uniqueid="1235234523.234"/> <call start_time="2010年06月01日 15:11:06" type="completed" queue_account_id="1113" queue_name="Sales" queue_extension="355" caller_id_number="101" caller_id_name="Jane Doe" origination="outgoing" wait_time="4" enter_position="1" talk_time="4" member_account_id="1102" member_name="Jimmy Dean" member_extension="155" member_misses="1" uniqueid="12352342343.244"/> <call start_time="2010年06月01日 15:11:17" type="redirected" queue_account_id="1113" queue_name="Sales" queue_extension="355" caller_id_number="101" caller_id_name="Jane Doe" origination="outgoing" wait_time="11" enter_position="1" exit_position="1" member_misses="0" uniqueid="1235223452.634"/> </calls> </result> </response>
Error Codes
- See the Error Code Formatting section to see the xml structure when an error is returned.
- See the Generic Error Codes section to see a list of general fault codes that may be returned.
Code
Description
77534
Invalid date (%1). Date and time format is (YYYY-MM-DD HH:MM:SS)
25673
Invalid date (%1). You selected the 31st of a month with only 30 days.
75429
Invalid date (%1). February 29th is outside a leap year.
63014
Invalid date (%1). February 30th and 31st do not exist.
12010
The 'To Date' is before your 'From Date'
87100
Invalid ignore_weekends
58020
Invalid call queue account ID (%1).
24915
You must supply at least one account ID.
54547
You must supply at least one call type.
43890
Invalid queue call type (%1).
87101
Invalid format
12016
Invalid sort field
12017
Invalid sort order
12018
items_per_page may only contain digits
12019
page_number may only contain digits