Skip to main content
GET
List opted-out phone numbers

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

sender_id
string

Filters opt-outs by the Sender ID they apply to.

campaign_id
string

Filters opt-outs by the 10DLC campaign ID they apply to.

created_after
string<date>

Returns opt-outs created on or after this date, in YYYY-MM-DD format.

created_before
string<date>

Returns opt-outs created on or before this date, in YYYY-MM-DD format.

page
integer

Page number to retrieve. Minimum 1, default 1.

Required range: x >= 1
per_page
integer

Number of records to return per page. Default 25, maximum 100.

Required range: 1 <= x <= 100

Response

Returns a paginated list of opted-out phone numbers.

items
OptOutItem · object[]

Opt-out records that match the request.

pagination
Pagination · object