Package com.ringcentral.definitions

Class SyncUserCallLogParameters

java.lang.Object

com.ringcentral.definitions.SyncUserCallLogParameters

public class SyncUserCallLogParameters
extends Object

Query parameters for operation syncUserCallLog

Field Summary

Fields

Modifier and Type	Field	Description
String	dateFrom	Starting date for the resulting records in ISO 8601 format, including timezone, for example *2016-03-10T18:07:52.534Z*.
String[]	metadataCategory	Category of metadata to be returned.
Long	recordCount	For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.
String	recordingType	Indicates that call records with recordings of particular type should be returned.
Boolean	showDeleted	Supported for `ISync` mode.
String[]	statusGroup	Type of calls to be returned Enum: Missed, All
String	syncToken	A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)
String	syncType	Type of call log synchronization request - full or incremental sync Default: FSync Enum: FSync, ISync
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
SyncUserCallLogParameters()

Method Summary

Modifier and Type	Method	Description
SyncUserCallLogParameters	dateFrom(String dateFrom)
SyncUserCallLogParameters	metadataCategory(String[] metadataCategory)
SyncUserCallLogParameters	recordCount(Long recordCount)
SyncUserCallLogParameters	recordingType(String recordingType)
SyncUserCallLogParameters	showDeleted(Boolean showDeleted)
SyncUserCallLogParameters	statusGroup(String[] statusGroup)
SyncUserCallLogParameters	syncToken(String syncToken)
SyncUserCallLogParameters	syncType(String syncType)
SyncUserCallLogParameters	view(String view)
SyncUserCallLogParameters	withRecording(Boolean withRecording)

Methods inherited from class java.lang.Object

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

Field Details

syncType

public String syncType

Type of call log synchronization request - full or incremental sync Default: FSync Enum: FSync, ISync

syncToken

public String syncToken

A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)

dateFrom

public String dateFrom

Starting date for the resulting records in ISO 8601 format, including timezone, for example *2016-03-10T18:07:52.534Z*. The range is limited to the last 30 days from the current moment. If not specified, the default value is a log history date (date of account creation/call log deletion), and no time range limitation applied Format: date-time

recordCount

public Long recordCount

For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.

For `ISync` mode this parameter specifies the number of records to extend the sync frame with to the past (the maximum number of records is 250) Format: int32

statusGroup

public String[] statusGroup

Type of calls to be returned Enum: Missed, All

view

public String view

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

showDeleted

public Boolean showDeleted

Supported for `ISync` mode. Indicates that deleted call records should be returned

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

metadataCategory

public String[] metadataCategory

Category of metadata to be returned. If omitted, all call records are returned. Multiple values are supported

Constructor Details

SyncUserCallLogParameters

public SyncUserCallLogParameters()

Method Details

syncType

public SyncUserCallLogParameters syncType(String syncType)

syncToken

public SyncUserCallLogParameters syncToken(String syncToken)

dateFrom

public SyncUserCallLogParameters dateFrom(String dateFrom)

recordCount

public SyncUserCallLogParameters recordCount(Long recordCount)

statusGroup

public SyncUserCallLogParameters statusGroup(String[] statusGroup)

view

public SyncUserCallLogParameters view(String view)

showDeleted

public SyncUserCallLogParameters showDeleted(Boolean showDeleted)

withRecording

public SyncUserCallLogParameters withRecording(Boolean withRecording)

recordingType

public SyncUserCallLogParameters recordingType(String recordingType)

metadataCategory

public SyncUserCallLogParameters metadataCategory(String[] metadataCategory)