Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const messagingOptoutListResponse of client.messagingOptouts.list()) {
  console.log(messagingOptoutListResponse.messaging_profile_id);
}

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

GET

messaging_optouts

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const messagingOptoutListResponse of client.messagingOptouts.list()) {
  console.log(messagingOptoutListResponse.messaging_profile_id);
}

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

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+00:00"

AI

Real-Time Communications

WebRTC

Messaging

Numbers & Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List opt-outs

Authorizations

Query Parameters

Response