RingCentral .Net SDK
Properties | List of all members
RingCentral.SyncMessagesParameters Class Reference

Query parameters for operation syncMessages More...

Properties

long? conversationId [get, set]
 Conversation identifier for the resulting messages. Meaningful for SMS and Pager messages only. Format: int64 More...
 
string dateFrom [get, set]
 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 More...
 
string dateTo [get, set]
 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 More...
 
string[] direction [get, set]
 Direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted Enum: Inbound, Outbound More...
 
bool? distinctConversations [get, set]
 If true, then the latest messages per every conversation ID are returned More...
 
string[] messageType [get, set]
 Type for the resulting messages. If not specified, all types of messages are returned. Multiple values are accepted Enum: Fax, SMS, VoiceMail, Pager More...
 
long? recordCount [get, set]
 Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified) Format: int32 More...
 
string syncToken [get, set]
 A syncToken value from the previous sync response (for ISync mode only, mandatory) More...
 
string syncType [get, set]
 Type of message synchronization request: More...
 
string[] voicemailOwner [get, set]
 This query parameter will filter voicemail messages based on its owner. This parameter should be controlled by the 'SharedVoicemail' feature. If the feature is disabled this filter shouldn't be applied. More...
 

Detailed Description

Query parameters for operation syncMessages

Property Documentation

◆ conversationId

long? RingCentral.SyncMessagesParameters.conversationId
getset

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

◆ dateFrom

string RingCentral.SyncMessagesParameters.dateFrom
getset

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

string RingCentral.SyncMessagesParameters.dateTo
getset

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

string [] RingCentral.SyncMessagesParameters.direction
getset

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

◆ distinctConversations

bool? RingCentral.SyncMessagesParameters.distinctConversations
getset

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

◆ messageType

string [] RingCentral.SyncMessagesParameters.messageType
getset

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

◆ recordCount

long? RingCentral.SyncMessagesParameters.recordCount
getset

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

◆ syncToken

string RingCentral.SyncMessagesParameters.syncToken
getset

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

◆ syncType

string RingCentral.SyncMessagesParameters.syncType
getset

Type of message synchronization request:

  • FSync – full sync
  • ISync – incremental sync Enum: FSync, ISync

◆ voicemailOwner

string [] RingCentral.SyncMessagesParameters.voicemailOwner
getset

This query parameter will filter voicemail messages based on its owner. This parameter should be controlled by the 'SharedVoicemail' feature. If the feature is disabled this filter shouldn't be applied.


The documentation for this class was generated from the following file: