switchvox.extensionGroups.getList

From SwitchvoxExtendAPI

(Difference between revisions)

Jump to: navigation, search

Revision as of 01:13, 28 February 2009

1 Description
2 Arguments
3 Example Requests & Responses
- 3.1 Example One

Description

Returns a call 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.
account_ids account_id	required (account searches)	integer		A list of account ids. To get a list of account_ids on your system or convert extensions to account_ids see switchvox.extensions.search.
iax_provider_ids iax_provider_id	required (provider searches)	integer		A list of IAX provider IDs.
sip_provider_ids sip_provider_id	required (provider searches)	integer		A list of SIP provider IDs.
channel_group_ids channel_group_id	required (provider searches)	integer		A list of channel group IDs.
incoming_did	required (did searches)	integer		Search based on incoming DID.
breakdown	optional	string	cumulative	The report breakdown. Possible values: cumulative, by_day, by_account, by_hour_of_day, and by_day_of_week.
report_fields report_field	optional	string	total_calls	A list of the fields to report. Possible values: total_calls, total_incoming_calls, total_outgoing_calls, talking_duration, call_duration, avg_talking_duration, and avg_call_duration.
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.
format	optional	string	xml	Format of the report. Possible values: xml and chart.
sort_field	optional	string	sort_name	The field on which to sort the returned report. Possible values: sort_name, date, hour, day_of_week, account, extension, total_calls, total_incoming_calls, total_outgoing_calls, talking_duration, call_duration, avg_talking_duration and avg_call_duration. Value ignored for cumulative searches.
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.

Example Requests & Responses

Please see the API Request and Response Format section for more information on various request encodings.

Example One

Request

Cumulative XML Report

<?xml version="1.0"?>
<request method="switchvox.callReports.search">
    <parameters>
        <start_date>2008-01-01 00:00:00</start_date>
        <end_date>2008-02-01 23:59:59</end_date>
        <ignore_weekends>1</ignore_weekends>
        <breakdown>cumulative</breakdown>
        <report_fields>
          <report_field>total_calls</report_field>
          <report_field>total_incoming_calls</report_field>
          <report_field>total_outgoing_calls</report_field>
          <report_field>talking_duration</report_field>
          <report_field>call_duration</report_field>
          <report_field>avg_talking_duration</report_field>
          <report_field>avg_call_duration</report_field>
        </report_fields>
        <format>xml</format>
    </parameters>
</request>

Response

<response method="switchvox.callReports.search">
  <result>
    <calls totals="464" incoming="74" outgoing="390" talk_time="33082" call_time="39971" avg_talk_time="71.29" avg_call_time="86.14" />
  </result>
</response>

Request

Example Request (By Account)

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

<?xml version="1.0"?>
<request method="switchvox.callReports.search">
    <parameters>
        <start_date>2008-01-01 00:00:00</start_date>
        <end_date>2008-02-01 23:59:59</end_date>
        <ignore_weekends>1</ignore_weekends>
        <breakdown>by_account</breakdown>
        <report_fields>
          <report_field>total_calls</report_field>
          <report_field>total_incoming_calls</report_field>
          <report_field>total_outgoing_calls</report_field>
          <report_field>talking_duration</report_field>
          <report_field>call_duration</report_field>
          <report_field>avg_talking_duration</report_field>
          <report_field>avg_call_duration</report_field>
        </report_fields>
        <format>xml</format>
        <sort_field>extension</sort_field>
        <sort_order>ASC</sort_order>
        <items_per_page>20</items_per_page>
        <page_number>1</page_number>
    </parameters>
</request>