RingCentral .Net SDK
Loading...
Searching...
No Matches
RingCentral.ListMessagesParameters Class Reference

Query parameters for operation listMessages. More...

Properties

string[] owner [get, set]
 Filters shared messages based on the owner extension. Supported if the 'SharedVoicemail' or 'CallQueueSmsRecipient' feature is enabled Default: Personal Enum: Any, Personal, Shared.
string[] availability [get, set]
 Specifies the availability status for resulting messages. Multiple values are accepted Enum: Alive, Deleted, Purged.
string conversationId [get, set]
 Specifies a conversation identifier for the resulting messages.
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.
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.
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.
bool? distinctConversations [get, set]
 If true, then the latest messages per every conversation ID are returned.
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.
string[] readStatus [get, set]
 Read status for resulting messages. Multiple values are accepted Enum: Read, Unread.
long? page [get, set]
 Indicates a page number to retrieve. Only positive number values are accepted Format: int32 Default: 1.
long? perPage [get, set]
 Indicates a page size (number of items) Format: int32 Default: 100.
string phoneNumber [get, set]
 Phone number. If specified, messages are returned for this particular phone number only.
string[] voicemailOwner [get, set]
 Deprecated. Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail' feature is enabled.
string[] ownerExtensionType [get, set]
 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, TieLine, VoiceAppIntegration, WebVoice, Unknown.

Detailed Description

Query parameters for operation listMessages.


The documentation for this class was generated from the following file:
  • RingCentral.Net/Definitions/ListMessagesParameters.cs