Package com.ringcentral.definitions

Class ListMessagesParameters

java.lang.Object

com.ringcentral.definitions.ListMessagesParameters

public class ListMessagesParameters
extends Object

Query parameters for operation listMessages

Field Summary

Fields

Modifier and Type	Field	Description
String[]	availability	Specifies the availability status for resulting messages.
String	conversationId	Specifies a conversation identifier for the resulting messages
String	dateFrom	Start date/time for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z.
String	dateTo	End date/time for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z.
String[]	direction	Direction for resulting messages.
Boolean	distinctConversations	If `true`, then the latest messages per every conversation ID are returned
String[]	messageType	Type of resulting messages.
Long	page	Indicates a page number to retrieve.
Long	perPage	Indicates a page size (number of items) Format: int32 Default: 100
String	phoneNumber	Phone number.
String[]	readStatus	Read status for resulting messages.

Constructor Summary

Constructors

Constructor	Description
ListMessagesParameters()

Method Summary

Modifier and Type	Method	Description
ListMessagesParameters	availability(String[] availability)
ListMessagesParameters	conversationId(String conversationId)
ListMessagesParameters	dateFrom(String dateFrom)
ListMessagesParameters	dateTo(String dateTo)
ListMessagesParameters	direction(String[] direction)
ListMessagesParameters	distinctConversations(Boolean distinctConversations)
ListMessagesParameters	messageType(String[] messageType)
ListMessagesParameters	page(Long page)
ListMessagesParameters	perPage(Long perPage)
ListMessagesParameters	phoneNumber(String phoneNumber)
ListMessagesParameters	readStatus(String[] readStatus)

Methods inherited from class java.lang.Object

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

Field Details

availability

public String[] availability

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

conversationId

public String conversationId

Specifies a conversation identifier for the resulting messages

dateFrom

public String dateFrom

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

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 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 of resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted Enum: Fax, SMS, VoiceMail, Pager

readStatus

public String[] readStatus

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

page

public Long page

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

perPage

public Long perPage

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

phoneNumber

public String phoneNumber

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

Constructor Details

ListMessagesParameters

public ListMessagesParameters()

Method Details

availability

public ListMessagesParameters availability(String[] availability)

conversationId

public ListMessagesParameters conversationId(String conversationId)

dateFrom

public ListMessagesParameters dateFrom(String dateFrom)

dateTo

public ListMessagesParameters dateTo(String dateTo)

direction

public ListMessagesParameters direction(String[] direction)

distinctConversations

public ListMessagesParameters distinctConversations(Boolean distinctConversations)

messageType

public ListMessagesParameters messageType(String[] messageType)

readStatus

public ListMessagesParameters readStatus(String[] readStatus)

page

public ListMessagesParameters page(Long page)

perPage

public ListMessagesParameters perPage(Long perPage)

phoneNumber

public ListMessagesParameters phoneNumber(String phoneNumber)