Package com.ringcentral.definitions

Class ReadCompanyCallLogParameters

java.lang.Object

com.ringcentral.definitions.ReadCompanyCallLogParameters

public class ReadCompanyCallLogParameters
extends Object

Query parameters for operation readCompanyCallLog

Field Summary

Fields

Modifier and Type	Field	Description
String	dateFrom	The beginning of the time range to return call records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z.
String	dateTo	The end of the time range to return call records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z.
String[]	direction	The direction of call records to be included in the result.
String	extensionNumber	Short extension number of a user.
Long	page	Indicates the page number to retrieve.
Long	perPage	Indicates the page size (number of items) Minimum: 1 Format: int32 Default: 100
String	phoneNumber	Phone number of a caller/callee in e.164 format without a '+' sign.
String	recordingType	Indicates that call records with recordings of particular type should be returned.
String	sessionId	Internal identifier of a call session
String	telephonySessionId	Internal identifier of a telephony session
String[]	type	The type of call records to be included in the result.
String	view	Defines the level of details for returned call records Default: Simple Enum: Simple, Detailed
Boolean	withRecording	Deprecated, replaced with `recordingType` filter, still supported for compatibility reasons.

Constructor Summary

Constructors

Constructor	Description
ReadCompanyCallLogParameters()

Method Summary

Modifier and Type	Method	Description
ReadCompanyCallLogParameters	dateFrom(String dateFrom)
ReadCompanyCallLogParameters	dateTo(String dateTo)
ReadCompanyCallLogParameters	direction(String[] direction)
ReadCompanyCallLogParameters	extensionNumber(String extensionNumber)
ReadCompanyCallLogParameters	page(Long page)
ReadCompanyCallLogParameters	perPage(Long perPage)
ReadCompanyCallLogParameters	phoneNumber(String phoneNumber)
ReadCompanyCallLogParameters	recordingType(String recordingType)
ReadCompanyCallLogParameters	sessionId(String sessionId)
ReadCompanyCallLogParameters	telephonySessionId(String telephonySessionId)
ReadCompanyCallLogParameters	type(String[] type)
ReadCompanyCallLogParameters	view(String view)
ReadCompanyCallLogParameters	withRecording(Boolean withRecording)

Methods inherited from class java.lang.Object

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

Field Details

extensionNumber

public String extensionNumber

Short extension number of a user. If specified, returns call log for this particular extension only. Cannot be combined with `phoneNumber` filter Example: 101

phoneNumber

public String phoneNumber

Phone number of a caller/callee in e.164 format without a '+' sign. If specified, all incoming/outgoing calls from/to this phone number are returned. Example: 12053320032

direction

public String[] direction

The direction of call records to be included in the result. If omitted, both inbound and outbound calls are returned. Multiple values are supported Enum: Inbound, Outbound

type

public String[] type

The type of call records to be included in the result. If omitted, all call types are returned. Multiple values are supported Enum: Voice, Fax

view

public String view

Defines the level of details for returned call records Default: Simple Enum: Simple, Detailed

withRecording

public Boolean withRecording

Deprecated, replaced with `recordingType` filter, still supported for compatibility reasons. Indicates if only recorded calls should be returned.

If both `withRecording` and `recordingType` parameters are specified, then `withRecording` is ignored

recordingType

public String recordingType

Indicates that call records with recordings of particular type should be returned. If omitted, then calls with and without recordings are returned Enum: Automatic, OnDemand, All

dateFrom

public String dateFrom

The beginning of the time range to return call records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is `dateTo` minus 24 hours Format: date-time

dateTo

public String dateTo

The end of the time range to return call records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time Format: date-time

sessionId

public String sessionId

Internal identifier of a call session

telephonySessionId

public String telephonySessionId

Internal identifier of a telephony session

page

public Long page

Indicates the page number to retrieve. Only positive number values are accepted Minimum: 1 Format: int32 Default: 1

perPage

public Long perPage

Indicates the page size (number of items) Minimum: 1 Format: int32 Default: 100

Constructor Details

ReadCompanyCallLogParameters

public ReadCompanyCallLogParameters()

Method Details

extensionNumber

public ReadCompanyCallLogParameters extensionNumber(String extensionNumber)

phoneNumber

public ReadCompanyCallLogParameters phoneNumber(String phoneNumber)

direction

public ReadCompanyCallLogParameters direction(String[] direction)

type

public ReadCompanyCallLogParameters type(String[] type)

view

public ReadCompanyCallLogParameters view(String view)

withRecording

public ReadCompanyCallLogParameters withRecording(Boolean withRecording)

recordingType

public ReadCompanyCallLogParameters recordingType(String recordingType)

dateFrom

public ReadCompanyCallLogParameters dateFrom(String dateFrom)

dateTo

public ReadCompanyCallLogParameters dateTo(String dateTo)

sessionId

public ReadCompanyCallLogParameters sessionId(String sessionId)

telephonySessionId

public ReadCompanyCallLogParameters telephonySessionId(String telephonySessionId)

page

public ReadCompanyCallLogParameters page(Long page)

perPage

public ReadCompanyCallLogParameters perPage(Long perPage)