RIringcentral
High Volume SMS

List Opted Out Numbers

Returns the list of numbers opted out from the account. The list can be filtered by to/from phone number query parameters. Specifying text/csv in the Accept header lets download the data in the CSV format.

get/restapi/v1.0/account/{accountId}/a2p-sms/opt-outs

Request

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Query parameters

fromstring

The sender's phone number in E.164 format for filtering messages. The asterisk value "*" means any number in from field

tostring

The receiver's phone number (to field) in E.164 format for filtering messages

status'optout' | 'optin' | 'all'

The status (opted out, opted in, or both) to be used as the filter

pageTokenstring

The page token of the page to be retrieved

perPageinteger

The number of records to be returned for the page

Response

Successful response

Example response

{
  "records": [
    {
      "from": "+15551234567",
      "to": "+15551234567"
    }
  ],
  "paging": {
    "pageToken": "pgt1",
    "perPage": 3,
    "firstPageToken": "fpgt1",
    "previousPageToken": "lpgt1",
    "nextPageToken": "npgt1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.