SMS and MMS
List opted-out phone numbers
Returns a paginated list of phone numbers that have opted out of receiving messages from the authenticated account.
get/v3/messages/opt-outs
Query parameters
sender_idstring
Filters opt-outs by the Sender ID they apply to.
campaign_idstring
Filters opt-outs by the 10DLC campaign ID they apply to.
created_afterstring date
Returns opt-outs created on or after this date, in YYYY-MM-DD format.
created_beforestring date
Returns opt-outs created on or before this date, in YYYY-MM-DD format.
pageinteger
Page number to retrieve. Minimum 1, default 1.
per_pageinteger
Number of records to return per page. Default 25, maximum 100.
Response
Returns a paginated list of opted-out phone numbers.
Example response
{
"items": [
{
"phone_number": "15551234567",
"sender_id": "MySender",
"campaign_id": "C123456",
"created_at": "2024-01-15T10:30:00Z"
}
],
"pagination": {
"current_page": 2,
"per_page": 25,
"total": 101,
"total_pages": 5
}
}