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 phoneNumberWithMessagingSettings of client.phoneNumbers.messaging.list()) {
  console.log(phoneNumberWithMessagingSettings.id);
}

{
  "data": [
    {
      "record_type": "messaging_settings",
      "id": "1293384261075731499",
      "phone_number": "+18005550001",
      "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z",
      "country_code": "US",
      "type": "tollfree",
      "health": {
        "message_count": 122,
        "inbound_outbound_ratio": 0.43,
        "success_ratio": 0.94,
        "spam_ratio": 0.06
      },
      "eligible_messaging_products": [
        "A2P"
      ],
      "traffic_type": "A2P",
      "messaging_product": "A2P",
      "features": {
        "sms": {
          "domestic_two_way": true,
          "international_inbound": true,
          "international_outbound": true
        },
        "mms": null
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

GET

phone_numbers

messaging

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 phoneNumberWithMessagingSettings of client.phoneNumbers.messaging.list()) {
  console.log(phoneNumberWithMessagingSettings.id);
}

{
  "data": [
    {
      "record_type": "messaging_settings",
      "id": "1293384261075731499",
      "phone_number": "+18005550001",
      "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z",
      "country_code": "US",
      "type": "tollfree",
      "health": {
        "message_count": 122,
        "inbound_outbound_ratio": 0.43,
        "success_ratio": 0.94,
        "spam_ratio": 0.06
      },
      "eligible_messaging_products": [
        "A2P"
      ],
      "traffic_type": "A2P",
      "messaging_product": "A2P",
      "features": {
        "sms": {
          "domestic_two_way": true,
          "international_inbound": true,
          "international_outbound": true
        },
        "mms": null
      }
    }
  ],
  "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

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

Response

Successful response with a list of phone numbers with messaging settings.

data

object[]

Show child attributes

data.record_type

enum<string>

Identifies the type of the resource.

Available options:

messaging_phone_number,

messaging_settings

Example:

"messaging_settings"

data.id

string

Identifies the type of resource.

data.phone_number

string<e164>

+E.164 formatted phone number.

data.messaging_profile_id

string | null

Unique identifier for a messaging profile.

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated.

data.country_code

string

ISO 3166-1 alpha-2 country code.

Example:

"US"

data.type

enum<string>

The type of the phone number

Available options:

long-code,

toll-free,

short-code,

longcode,

tollfree,

shortcode

data.health

object

High level health metrics about the number and it's messaging sending patterns.

Show child attributes

data.health.message_count

integer

required

The number of messages analyzed for the health metrics.

data.health.inbound_outbound_ratio

number<float>

required

The ratio of messages received to the number of messages sent.

data.health.success_ratio

number<float>

required

The ratio of messages sucessfully delivered to the number of messages attempted.

data.health.spam_ratio

number<float>

required

The ratio of messages blocked for spam to the number of messages attempted.

Example:

{
  "message_count": 10,
  "inbound_outbound_ratio": 1,
  "success_ratio": 2,
  "spam_ratio": 10
}

data.eligible_messaging_products

string[]

The messaging products that this number can be registered to use

data.traffic_type

string

The messaging traffic or use case for which the number is currently configured.

Example:

"P2P"

data.messaging_product

string

The messaging product that the number is registered to use

Example:

"P2P"

data.features

object

Show child attributes

data.features.sms

object

The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as its current product configuration.

Show child attributes

data.features.sms.domestic_two_way

boolean

required

Send messages to and receive messages from numbers in the same country.

data.features.sms.international_inbound

boolean

required

Receive messages from numbers in other countries.

data.features.sms.international_outbound

boolean

required

Send messages to numbers in other countries.

Example:

{
  "domestic_two_way": true,
  "international_inbound": false,
  "international_outbound": true
}

data.features.mms

object

The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as its current product configuration.

Show child attributes

data.features.mms.domestic_two_way

boolean

required

Send messages to and receive messages from numbers in the same country.

data.features.mms.international_inbound

boolean

required

Receive messages from numbers in other countries.

data.features.mms.international_outbound

boolean

required

Send messages to numbers in other countries.

Example:

{
  "domestic_two_way": true,
  "international_inbound": false,
  "international_outbound": true
}

AI

Real-Time Communications

WebRTC

Messaging

Numbers & Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List phone numbers with messaging settings

Authorizations

Query Parameters

Response