Personal tools

switchvox.scheduledReports.callReports.getList

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Get a list of all the scheduled call reports on your system.

Arguments

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

This method doesn't take any parameters.

Example Requests & Responses

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

Example One

Request

<request method="switchvox.scheduledReports.callReports.getList">
  <parameters>
  </parameters>
</request>

Response

<response method="switchvox.scheduledReports.callReports.getList">
	<result>
		<scheduled_reports>
				<scheduled_report id="22" name="Sample Report" type="call_report" schedule_id="23" format="" delivery_email_address="">
						<schedule id="23" name="Every Hour 8 thru 6" end_date="2038-01-01 23:59:59" start_date="2009-03-02 00:00:00" recurrence_frequency="3h"  >
							<time_ranges>
								<time_range start_hour="08" start_minute="00" end_hour="18" end_minute="00" />
							</time_ranges>
						</schedule>
					<report_parameters>
							<parameter breakdown="by_account" />
							<parameter>
								<report_fields>
									<report_field name="total_calls" />
								</report_fields>
							</parameter>
							<parameter ignore_weekends="0" />
							<parameter scheduled_report_format="chart" />
							<parameter delivery_email="dwp-test@switchvox.com" />
							<parameter type="all" />
							<parameter account_type="overview" />
							<parameter start_from_beginning="day" />
					</report_parameters>
				</scheduled_report>
				<scheduled_report id="24" name="Another Sample Report" type="call_report" schedule_id="23" format="" delivery_email_address="">
						<schedule id="23" name="Sample Schedule" end_date="2038-01-01 23:59:59" start_date="2009-03-02 00:00:00" recurrence_frequency="3h"  >
							<time_ranges>
								<time_range start_hour="08" start_minute="00" end_hour="18" end_minute="00" />
							</time_ranges>
						</schedule>
					<report_parameters>
							<parameter breakdown="cumulative" />
							<parameter ignore_weekends="1" />
							<parameter scheduled_report_format="chart" />
							<parameter sort_order="ASC" />
							<parameter sort_field="sort_name" />
							<parameter delivery_email="test@switchvox.com" />
							<parameter page_number="1" />
							<parameter>
								<account_ids>
									<account id="1107" />
								</account_ids>
							</parameter>
							<parameter start_from_beginning="day" />
							<parameter>
								<report_fields>
									<report_field name="avg_call_duration" />
									<report_field name="talking_duration" />
									<report_field name="total_outgoing_calls" />
									<report_field name="total_incoming_calls" />
									<report_field name="avg_talking_duration" />
									<report_field name="total_calls" />
									<report_field name="call_duration" />
								</report_fields>
							</parameter>
							<parameter items_per_page="50" />
					</report_parameters>
				</scheduled_report>
		</scheduled_reports>
	</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.

This method doesn't throw any method specific faults.

Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.scheduledReports.callReports.getList"