Package com.ringcentral.definitions

Class SearchSmsConsentRecordsRequest

java.lang.Object

com.ringcentral.definitions.SearchSmsConsentRecordsRequest

public class SearchSmsConsentRecordsRequest
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String[]	campaignType	The campaign type(s) used to filter records (if requested `coverage` is `CampaignType`) Enum: Conversational, Informational, Promotional
String[]	coverage	The coverage(s) used to filter records Enum: PhoneNumber, Account, CampaignType
String[]	from	The internal party's phone number(s) used to filter records (if requested `coverage` is `PhoneNumber` or `Account`)
String	optStatus	Consent status of a recipient's phone number: - `OptOut` - The number is opted out of receiving SMS.
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 external party's phone number(s) used to filter records

Constructor Summary

Constructors

Constructor	Description
SearchSmsConsentRecordsRequest()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

from

public String[] from

The internal party's phone number(s) used to filter records (if requested `coverage` is `PhoneNumber` or `Account`)

to

public String[] to

The external party's phone number(s) used to filter records

optStatus

public String optStatus

Consent status of a recipient's phone number: - `OptOut` - The number is opted out of receiving SMS. - `OptIn` - The number is opted in to receiving SMS (if it was previously opted out). Example: OptOut Enum: OptOut, OptIn

coverage

public String[] coverage

The coverage(s) used to filter records Enum: PhoneNumber, Account, CampaignType

campaignType

public String[] campaignType

The campaign type(s) used to filter records (if requested `coverage` is `CampaignType`) Enum: Conversational, Informational, Promotional

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 Default: 100

Constructor Details

SearchSmsConsentRecordsRequest

public SearchSmsConsentRecordsRequest()

Method Details

from

public SearchSmsConsentRecordsRequest from(String[] from)

to

public SearchSmsConsentRecordsRequest to(String[] to)

optStatus

public SearchSmsConsentRecordsRequest optStatus(String optStatus)

coverage

public SearchSmsConsentRecordsRequest coverage(String[] coverage)

campaignType

public SearchSmsConsentRecordsRequest campaignType(String[] campaignType)

pageToken

public SearchSmsConsentRecordsRequest pageToken(String pageToken)

perPage

public SearchSmsConsentRecordsRequest perPage(Long perPage)