Package com.ringcentral.definitions

Class CallFilters

java.lang.Object

com.ringcentral.definitions.CallFilters

public class CallFilters
extends Object

Optional filters that limit the scope of calls (joined via AND)

Field Summary

Fields

Modifier and Type	Field	Description
String[]	callActions	Filtering of calls by presence of specific action (joined via OR) Enum: HoldOff, HoldOn, ParkOn, ParkOff, BlindTransfer, WarmTransfer, DTMFTransfer
CallDurationFilter	callDuration
String[]	calledNumbers	The direct company numbers the caller called (joined via OR)
String[]	callResponses	Filtering of calls by first response (joined via OR) Enum: Answered, NotAnswered, Connected, NotConnected
String[]	callResults	Filtering of calls by the nature of call result (joined via OR) Enum: Completed, Abandoned, Voicemail, Unknown, Missed, Accepted
CallSegmentFilter[]	callSegments	Filtering of calls by presence of specific segment (joined via OR)
String[]	callTypes	Filtering of calls based on how the call started from the callee perspective (joined via OR).
String[]	companyHours	Filtering of calls by company's business hours or after hours (joined via OR) Enum: BusinessHours, AfterHours
String[]	directions	Specifies the call directions relative to the scope specified in grouping object (joined via OR).
ExtensionFilters	extensionFilters
String[]	origins	Specifies whether an external party was present in the initial segment of the call (joined via OR) Enum: Internal, External
String[]	queues	List of queues extension ids which allows to get data only for calls that were routed through any of these queues
String[]	queueSla	Filtering calls that were within or out of queue SLA (joined via OR).
TimeSpentFilter	timeSpent

Constructor Summary

Constructors

Constructor	Description
CallFilters()

Method Summary

Modifier and Type	Method	Description
CallFilters	callActions(String[] callActions)
CallFilters	callDuration(CallDurationFilter callDuration)
CallFilters	calledNumbers(String[] calledNumbers)
CallFilters	callResponses(String[] callResponses)
CallFilters	callResults(String[] callResults)
CallFilters	callSegments(CallSegmentFilter[] callSegments)
CallFilters	callTypes(String[] callTypes)
CallFilters	companyHours(String[] companyHours)
CallFilters	directions(String[] directions)
CallFilters	extensionFilters(ExtensionFilters extensionFilters)
CallFilters	origins(String[] origins)
CallFilters	queues(String[] queues)
CallFilters	queueSla(String[] queueSla)
CallFilters	timeSpent(TimeSpentFilter timeSpent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

extensionFilters

public ExtensionFilters extensionFilters

queues

public String[] queues

List of queues extension ids which allows to get data only for calls that were routed through any of these queues

calledNumbers

public String[] calledNumbers

The direct company numbers the caller called (joined via OR)

directions

public String[] directions

Specifies the call directions relative to the scope specified in grouping object (joined via OR). Not applicable to internal origin calls with company scope Enum: Inbound, Outbound

origins

public String[] origins

Specifies whether an external party was present in the initial segment of the call (joined via OR) Enum: Internal, External

callResponses

public String[] callResponses

Filtering of calls by first response (joined via OR) Enum: Answered, NotAnswered, Connected, NotConnected

callResults

public String[] callResults

Filtering of calls by the nature of call result (joined via OR) Enum: Completed, Abandoned, Voicemail, Unknown, Missed, Accepted

callSegments

public CallSegmentFilter[] callSegments

Filtering of calls by presence of specific segment (joined via OR)

callActions

public String[] callActions

Filtering of calls by presence of specific action (joined via OR) Enum: HoldOff, HoldOn, ParkOn, ParkOff, BlindTransfer, WarmTransfer, DTMFTransfer

companyHours

public String[] companyHours

Filtering of calls by company's business hours or after hours (joined via OR) Enum: BusinessHours, AfterHours

callDuration

public CallDurationFilter callDuration

timeSpent

public TimeSpentFilter timeSpent

queueSla

public String[] queueSla

Filtering calls that were within or out of queue SLA (joined via OR). Only applicable to Queues grouping Enum: InSla, OutSla

callTypes

public String[] callTypes

Filtering of calls based on how the call started from the callee perspective (joined via OR). If the call is outbound relative to the grouping scope, CallType is Outbound Enum: Direct, FromQueue, ParkRetrieval, Transferred, Outbound, Overflow

Constructor Details

CallFilters

public CallFilters()

Method Details

extensionFilters

public CallFilters extensionFilters(ExtensionFilters extensionFilters)

queues

public CallFilters queues(String[] queues)

calledNumbers

public CallFilters calledNumbers(String[] calledNumbers)

directions

public CallFilters directions(String[] directions)

origins

public CallFilters origins(String[] origins)

callResponses

public CallFilters callResponses(String[] callResponses)

callResults

public CallFilters callResults(String[] callResults)

callSegments

public CallFilters callSegments(CallSegmentFilter[] callSegments)

callActions

public CallFilters callActions(String[] callActions)

companyHours

public CallFilters companyHours(String[] companyHours)

callDuration

public CallFilters callDuration(CallDurationFilter callDuration)

timeSpent

public CallFilters timeSpent(TimeSpentFilter timeSpent)

queueSla

public CallFilters queueSla(String[] queueSla)

callTypes

public CallFilters callTypes(String[] callTypes)