Package com.ringcentral.paths.restapi.v2.accounts.sms.consents.export

Class Index

java.lang.Object

com.ringcentral.paths.restapi.v2.accounts.sms.consents.export.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent)

Method Summary

Modifier and Type	Method	Description
String	get()	Returns a list of account-level SMS consent records for opted-out and/or opted-in phone numbers in CSV format.
String	path()
String	path(Boolean withParameter)

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

Constructor Details

Index

public Index(Index parent)

Method Details

path

public String path()

path

public String path(Boolean withParameter)

get

public String get()
           throws RestException,
IOException

Returns a list of account-level SMS consent records for opted-out and/or opted-in phone numbers in CSV format. The following columns will be included in the resulted CSV file:

| Column name | Data type | Description | |-----------------------|-----------|------------------------------------------------------------------| | External Party Number | string | Sender's number in E.164 format | | Internal Party Number | string | Recipient's number in E.164 format | | Consent Status | string | Consent status, either "OptOut" or "OptIn" | | Source | string | Source of the consent record | | Coverage | string | Coverage of this consent record (Account is returned as Company) | | Campaign Type | string | Campaign type for this consent record | | Notes | string | Notes and comments regarding this consent record | | Last Modified Time | string | Last Modified Time in ISO 8601 format |

HTTP Method: get Endpoint: /restapi/v2/accounts/{accountId}/sms/consents/export Rate Limit Group: Light App Permission: SMS

Throws:

RestException

IOException