Package com.ringcentral.definitions

Class AggregateA2PSMSStatusesParameters

java.lang.Object

com.ringcentral.definitions.AggregateA2PSMSStatusesParameters

public class AggregateA2PSMSStatusesParameters
extends Object

Query parameters for operation aggregateA2PSMSStatuses

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[]	phoneNumber	List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results.

Constructor Summary

Constructors

Constructor	Description
AggregateA2PSMSStatusesParameters()

Method Summary

Modifier and Type	Method	Description
AggregateA2PSMSStatusesParameters	batchId(String batchId)
AggregateA2PSMSStatusesParameters	dateFrom(String dateFrom)
AggregateA2PSMSStatusesParameters	dateTo(String dateTo)
AggregateA2PSMSStatusesParameters	direction(String[] direction)
AggregateA2PSMSStatusesParameters	phoneNumber(String[] phoneNumber)

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)

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

Constructor Details

AggregateA2PSMSStatusesParameters

public AggregateA2PSMSStatusesParameters()

Method Details

batchId

public AggregateA2PSMSStatusesParameters batchId(String batchId)

direction

public AggregateA2PSMSStatusesParameters direction(String[] direction)

dateFrom

public AggregateA2PSMSStatusesParameters dateFrom(String dateFrom)

dateTo

public AggregateA2PSMSStatusesParameters dateTo(String dateTo)

phoneNumber

public AggregateA2PSMSStatusesParameters phoneNumber(String[] phoneNumber)