Package com.ringcentral.definitions

Class ListSmsConsentRecordsParameters

java.lang.Object

com.ringcentral.definitions.ListSmsConsentRecordsParameters

public class ListSmsConsentRecordsParameters
extends Object

Query parameters for operation listSmsConsentRecords

Field Summary

Fields

Modifier and Type	Field	Description
String[]	from	The sender's phone number(s) used to filter records
String[]	optStatus	The opt-out/opt-in status to filter records by.
String	pageToken	The token indicating the particular page of the result set to be retrieved.
Long	perPage	The number of items per page.
String[]	to	The recipient's phone number(s) used to filter records

Constructor Summary

Constructors

Constructor	Description
ListSmsConsentRecordsParameters()

Method Summary

Modifier and Type	Method	Description
ListSmsConsentRecordsParameters	from(String[] from)
ListSmsConsentRecordsParameters	optStatus(String[] optStatus)
ListSmsConsentRecordsParameters	pageToken(String pageToken)
ListSmsConsentRecordsParameters	perPage(Long perPage)
ListSmsConsentRecordsParameters	to(String[] to)

Methods inherited from class java.lang.Object

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

Field Details

pageToken

public String pageToken

The token indicating the particular page of the result set to be retrieved. If omitted the first page will be returned.

perPage

public Long perPage

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied Maximum: 1000 Minimum: 1 Format: int32 Example: 100 Default: 100

from

public String[] from

The sender's phone number(s) used to filter records

to

public String[] to

The recipient's phone number(s) used to filter records

optStatus

public String[] optStatus

The opt-out/opt-in status to filter records by. If omitted, `OptOut` records are returned Default: OptOut Enum: OptOut, OptIn

Constructor Details

ListSmsConsentRecordsParameters

public ListSmsConsentRecordsParameters()

Method Details

pageToken

public ListSmsConsentRecordsParameters pageToken(String pageToken)

perPage

public ListSmsConsentRecordsParameters perPage(Long perPage)

from

public ListSmsConsentRecordsParameters from(String[] from)

to

public ListSmsConsentRecordsParameters to(String[] to)

optStatus

public ListSmsConsentRecordsParameters optStatus(String[] optStatus)