Telnyx

{ "data": [ { "from": "<string>", "to": "+E.164", "messaging_profile_id": "<string>", "keyword": "STOP", "created_at": "2025-04-28 12:00:38.631252" } ], "meta": { "page_number": 2, "page_size": 25, "total_pages": 3, "total_results": 55 } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

redaction_enabled

string<boolean>

If receiving address (+E.164 formatted phone number) should be redacted

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id], filter[from]

Show child attributes

filter[messaging_profile_id]

string

The ID of the messaging profile to retrieve opt-outs for

filter[from]

string

The sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code) to retrieve opt-outs for

page

object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

created_at

object

Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]

Show child attributes

created_at[gte]

string<date-time>

Filter opt-outs created after this date (ISO-8601 format)

created_at[lte]

string<date-time>

Filter opt-outs created before this date (ISO-8601 format)

Response

Successful response with opt-out list data

data

object[]

Show child attributes

data.from

string<address>

Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).

data.to

string<address>

Receiving address (+E.164 formatted phone number or short code).

Example:

"+E.164"

data.messaging_profile_id

string | null

Unique identifier for a messaging profile.

data.keyword

string | null

The keyword that triggered the opt-out.

Example:

"STOP"

data.created_at

string<date-time>

The timestamp when the opt-out was created

Example:

"2025-04-28 12:00:38.631252"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup