GET api/revenueassurance/GetCallAnalysis?BillingPeriodId={BillingPeriodId}&BillRunId={BillRunId}&CompanyId={CompanyId}&SiteId={SiteId}&CalledFrom={CalledFrom}&CalledTo={CalledTo}&DestinationIds={DestinationIds}&ChargeCategoryIds={ChargeCategoryIds}&CallFromDate={CallFromDate}&CallToDate={CallToDate}&CallFromTime={CallFromTime}&CallToTime={CallToTime}&LimitId={LimitId}&LimitValue={LimitValue}&CallCostFrom={CallCostFrom}&CallCostTo={CallCostTo}&ExtensionFrom={ExtensionFrom}&ExtensionTo={ExtensionTo}&DurationFrom={DurationFrom}&DurationTo={DurationTo}&CallTypeId={CallTypeId}&Carrier={Carrier}&ExtensionNo={ExtensionNo}&CarrierCostFrom={CarrierCostFrom}&CarrierCostTo={CarrierCostTo}&UsageFrom={UsageFrom}&UsageTo={UsageTo}&PageSize={PageSize}&StartRow={StartRow}&SortColumn={SortColumn}&SortDirection={SortDirection}

This method returns details for the call analysis using the specified filter fields

Notes:

Limit Id field

  • 0 - Site Daily Spend
  • 1 - Number of outbound calls
  • 2 - Call cost
  • 3 - Call duration
  • 4 - CLI daily spend
  • 6 - Site hourly spend

Call Type Id field

  • 1 - ISDN Data
  • 2 - Freephone
  • 3 - Local Rate
  • 4 - Mobile
  • 5 - National Rate
  • 6 - Premium Rate
  • 7 - Voice
  • 8 - Excess data usage
  • 9 - GPRS Transmission
  • 10 - GPRS Recieve
  • 11 - Barred outgoing
  • 12 - Unanswered inbound
  • 13 - Busy inbound
  • 14 - Voice or ISDN Data(Rejects)
  • 15 - Non chareable inbound
  • 16 - Conference
Error messages
  • 403/Forbidden - Billing period is required
  • 403/Forbidden - Page size must be between 1 and 1000
  • 403/Forbidden - Invalid permissions to filter based on carrier cost

Request Information

URI Parameters

NameDescriptionTypeAdditional information
BillingPeriodId The id for the billing period. This field is required integer

Required
BillRunId The id for the bill run integer

None.
CompanyId The id for the Company integer

None.
SiteId The id for the site integer

None.
CalledFrom The number called from string

None.
CalledTo The number called to string

None.
DestinationIds A comma seperated list of destination id's string

None.
ChargeCategoryIds A comma seperated list of charge category id's string

None.
CallFromDate The call from date. eg. 28/JUN/2015, 28-JUN-2015, 06/28/2015 date

None.
CallToDate The call to date. eg. 28/JUN/2015, 28-JUN-2015, 06/28/2015 date

None.
CallFromTime The call from time date

None.
CallToTime The call to time date

None.
LimitId The id of the field to apply a limit to integer

None.
LimitValue The value of the limit string

None.
CallCostFrom The call cost from value decimal number

None.
CallCostTo The call cost to value decimal number

None.
ExtensionFrom The extension number lower range value string

None.
ExtensionTo The extension number upper range value string

None.
DurationFrom The duration from in minutes decimal number

None.
DurationTo The duration to in minutes decimal number

None.
CallTypeId The id of the call type integer

None.
Carrier The name of the carrier string

None.
ExtensionNo string

None.
CarrierCostFrom The carrier cost from value decimal number

None.
CarrierCostTo The carrier cost to value decimal number

None.
UsageFrom The usage from value decimal number

None.
UsageTo The usage to value decimal number

None.
PageSize The number of records to return. Size must be between 1 and 1000 integer

Range: inclusive between 1 and 1000
StartRow The start row for the data returned integer

None.
SortColumn The column to sort against string

None.
SortDirection The sort direction string

None.

Body Parameters

None.

Response Information

Resource Description

The itemised rated call records

CallAnalysisSummary
NameDescriptionTypeAdditional information
Data List of call records Collection of CallAnalysisEntry

None.
RecordCount Total count of records found that match filter integer

None.