Package com.ringcentral.definitions

Class SyncMessagesParameters

java.lang.Object

com.ringcentral.definitions.SyncMessagesParameters

public class SyncMessagesParameters
extends Object

Query parameters for operation syncMessages

Field Summary

Fields

Modifier and Type	Field	Description
Long	conversationId	Conversation identifier for the resulting messages.
String	dateFrom	The start date/time for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z.
String	dateTo	The end date/time for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z.
String[]	direction	Direction for the resulting messages.
Boolean	distinctConversations	If `true`, then the latest messages per every conversation ID are returned
String[]	messageType	Type for the resulting messages.
String[]	owner	Filters shared messages based on the owner extension.
String[]	ownerExtensionType	Filters shared messages based on the owner extension type.
Long	recordCount	Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified) Format: int32
String	syncToken	A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)
String	syncType	Type of message synchronization request: - FSync -- full sync - ISync -- incremental sync Enum: FSync, ISync
String[]	voicemailOwner	Deprecated.

Constructor Summary

Constructors

Constructor	Description
SyncMessagesParameters()

Method Summary

Modifier and Type	Method	Description
SyncMessagesParameters	conversationId(Long conversationId)
SyncMessagesParameters	dateFrom(String dateFrom)
SyncMessagesParameters	dateTo(String dateTo)
SyncMessagesParameters	direction(String[] direction)
SyncMessagesParameters	distinctConversations(Boolean distinctConversations)
SyncMessagesParameters	messageType(String[] messageType)
SyncMessagesParameters	owner(String[] owner)
SyncMessagesParameters	ownerExtensionType(String[] ownerExtensionType)
SyncMessagesParameters	recordCount(Long recordCount)
SyncMessagesParameters	syncToken(String syncToken)
SyncMessagesParameters	syncType(String syncType)
SyncMessagesParameters	voicemailOwner(String[] voicemailOwner)

Methods inherited from class java.lang.Object

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

Field Details

conversationId

public Long conversationId

Conversation identifier for the resulting messages. Meaningful for SMS and Pager messages only. Format: int64

dateFrom

public String dateFrom

The start date/time for resulting messages 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 date/time for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time Format: date-time

direction

public String[] direction

Direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted Enum: Inbound, Outbound

distinctConversations

public Boolean distinctConversations

If `true`, then the latest messages per every conversation ID are returned

messageType

public String[] messageType

Type for the resulting messages. If not specified, all types of messages are returned. Multiple values are accepted Enum: Fax, SMS, VoiceMail, Pager

recordCount

public Long recordCount

Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified) Format: int32

syncToken

public String syncToken

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

syncType

public String syncType

Type of message synchronization request: - FSync -- full sync - ISync -- incremental sync Enum: FSync, ISync

voicemailOwner

public String[] voicemailOwner

Deprecated. Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail' feature is enabled. Default: Personal Enum: Any, Personal, Shared

owner

public String[] owner

Filters shared messages based on the owner extension. Supported if the 'SharedVoicemail' or 'CallQueueSmsRecipient' feature is enabled. Default: Personal Enum: Any, Personal, Shared

ownerExtensionType

public String[] ownerExtensionType

Filters shared messages based on the owner extension type. Supported if "SharedVoicemail" or "CallQueueSmsRecipient" feature is enabled. Enum: User, Department, Announcement, Voicemail, DigitalUser, VirtualUser, FaxUser, PagingOnly, SharedLinesGroup, DelegatedLinesGroup, GroupCallPickup, IvrMenu, ApplicationExtension, ProxyAdmin, RoomConnector, ParkLocation, Limited, Bot, Site, Room, FlexibleUser, Unknown

Constructor Details

SyncMessagesParameters

public SyncMessagesParameters()

Method Details

conversationId

public SyncMessagesParameters conversationId(Long conversationId)

dateFrom

public SyncMessagesParameters dateFrom(String dateFrom)

dateTo

public SyncMessagesParameters dateTo(String dateTo)

direction

public SyncMessagesParameters direction(String[] direction)

distinctConversations

public SyncMessagesParameters distinctConversations(Boolean distinctConversations)

messageType

public SyncMessagesParameters messageType(String[] messageType)

recordCount

public SyncMessagesParameters recordCount(Long recordCount)

syncToken

public SyncMessagesParameters syncToken(String syncToken)

syncType

public SyncMessagesParameters syncType(String syncType)

voicemailOwner

public SyncMessagesParameters voicemailOwner(String[] voicemailOwner)

owner

public SyncMessagesParameters owner(String[] owner)

ownerExtensionType

public SyncMessagesParameters ownerExtensionType(String[] ownerExtensionType)