Package com.ringcentral.definitions

Class ListA2PSMSParameters

java.lang.Object

com.ringcentral.definitions.ListA2PSMSParameters

public class ListA2PSMSParameters
extends Object

Query parameters for operation listA2PSMS

Field Summary

Fields

Modifier and Type	Field	Description
String	batchId	Internal identifier of a message batch to filter the response Example: 55577
String	dateFrom	The beginning of the time range to filter the results in ISO 8601 format including timezone.
String	dateTo	The end of the time range to filter the results in ISO 8601 format including timezone.
String[]	direction	Direction of a message to filter the message list result.
String	pageToken	The page token of the page to be retrieved.
Long	perPage	The number of messages to be returned per request Format: int32 Example: 1 Default: 1000
String[]	phoneNumber	List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results.
String	view	Indicates if the response has to be detailed, includes text in the response if detailed Default: Simple Enum: Simple, Detailed

Constructor Summary

Constructors

Constructor	Description
ListA2PSMSParameters()

Method Summary

Modifier and Type	Method	Description
ListA2PSMSParameters	batchId(String batchId)
ListA2PSMSParameters	dateFrom(String dateFrom)
ListA2PSMSParameters	dateTo(String dateTo)
ListA2PSMSParameters	direction(String[] direction)
ListA2PSMSParameters	pageToken(String pageToken)
ListA2PSMSParameters	perPage(Long perPage)
ListA2PSMSParameters	phoneNumber(String[] phoneNumber)
ListA2PSMSParameters	view(String view)

Methods inherited from class java.lang.Object

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

Field Details

batchId

public String batchId

Internal identifier of a message batch to filter the response Example: 55577

direction

public String[] direction

Direction of a message to filter the message list result. By default, there is no filter applied - both Inbound and Outbound messages are returned Example: Inbound Enum: Inbound, Outbound

dateFrom

public String dateFrom

The beginning of the time range to filter the results in ISO 8601 format including timezone. Default is the `dateTo` minus 24 hours Format: date-time Example: Mon Nov 09 2020 08:07:52 GMT-0800 (Pacific Standard Time)

dateTo

public String dateTo

The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time Format: date-time Example: Wed Nov 25 2020 08:07:52 GMT-0800 (Pacific Standard Time)

view

public String view

Indicates if the response has to be detailed, includes text in the response if detailed Default: Simple Enum: Simple, Detailed

phoneNumber

public String[] phoneNumber

List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15 Example: 15551234455,15551235577

pageToken

public String pageToken

The page token of the page to be retrieved. Example: pgt1

perPage

public Long perPage

The number of messages to be returned per request Format: int32 Example: 1 Default: 1000

Constructor Details

ListA2PSMSParameters

public ListA2PSMSParameters()

Method Details

batchId

public ListA2PSMSParameters batchId(String batchId)

direction

public ListA2PSMSParameters direction(String[] direction)

dateFrom

public ListA2PSMSParameters dateFrom(String dateFrom)

dateTo

public ListA2PSMSParameters dateTo(String dateTo)

view

public ListA2PSMSParameters view(String view)

phoneNumber

public ListA2PSMSParameters phoneNumber(String[] phoneNumber)

pageToken

public ListA2PSMSParameters pageToken(String pageToken)

perPage

public ListA2PSMSParameters perPage(Long perPage)