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

Query parameters for operation listMessages More...

Properties

string[] availability [get, set]
 Specifies the availability status for resulting messages. Multiple values are accepted Enum: Alive, Deleted, Purged More...
 
string conversationId [get, set]
 Specifies a conversation identifier for the resulting messages More...
 
string dateFrom [get, set]
 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]
 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 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 of resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted Enum: Fax, SMS, VoiceMail, Pager More...
 
string[] readStatus [get, set]
 Read status for resulting messages. Multiple values are accepted Enum: Read, Unread More...
 
long? page [get, set]
 Indicates a page number to retrieve. Only positive number values are accepted Format: int32 Default: 1 More...
 
long? perPage [get, set]
 Indicates a page size (number of items) Format: int32 Default: 100 More...
 
string phoneNumber [get, set]
 Phone number. If specified, messages are returned for this particular phone number only More...
 

Detailed Description

Query parameters for operation listMessages

Property Documentation

◆ availability

string [] RingCentral.ListMessagesParameters.availability
getset

Specifies the availability status for resulting messages. Multiple values are accepted Enum: Alive, Deleted, Purged

◆ conversationId

string RingCentral.ListMessagesParameters.conversationId
getset

Specifies a conversation identifier for the resulting messages

◆ dateFrom

string RingCentral.ListMessagesParameters.dateFrom
getset

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.ListMessagesParameters.dateTo
getset

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.ListMessagesParameters.direction
getset

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

◆ distinctConversations

bool? RingCentral.ListMessagesParameters.distinctConversations
getset

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

◆ messageType

string [] RingCentral.ListMessagesParameters.messageType
getset

Type of resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted Enum: Fax, SMS, VoiceMail, Pager

◆ page

long? RingCentral.ListMessagesParameters.page
getset

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

◆ perPage

long? RingCentral.ListMessagesParameters.perPage
getset

Indicates a page size (number of items) Format: int32 Default: 100

◆ phoneNumber

string RingCentral.ListMessagesParameters.phoneNumber
getset

Phone number. If specified, messages are returned for this particular phone number only

◆ readStatus

string [] RingCentral.ListMessagesParameters.readStatus
getset

Read status for resulting messages. Multiple values are accepted Enum: Read, Unread


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