Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const messagingProfile = await client.messagingProfiles.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); console.log(messagingProfile.data);

{ "data": { "record_type": "messaging_profile", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Profile for Messages", "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "enabled": true, "webhook_api_version": "2", "whitelisted_destinations": [ "US" ], "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "number_pool_settings": { "toll_free_weight": 10, "long_code_weight": 2, "skip_unhealthy": false, "sticky_sender": true, "geomatch": false }, "url_shortener_settings": { "domain": "example.ex", "prefix": "cmpny", "replace_blacklist_only": true, "send_webhooks": false }, "v1_secret": "rP1VamejkU2v0qIUxntqLW2c", "health_webhook_url": null, "mms_fall_back_to_sms": false, "mms_transcoding": false, "daily_spend_limit": "100.00", "daily_spend_limit_enabled": false, "redaction_enabled": false, "redaction_level": 2, "mobile_only": false } }

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

The id of the messaging profile to retrieve

Response

Successful response with details about a messaging profile.

data

object

Show child attributes

data.record_type

enum<string>

Identifies the type of the resource.

Available options:

messaging_profile

data.id

string<uuid>

Identifies the type of resource.

data.mms_fall_back_to_sms

boolean

default:false

enables SMS fallback for MMS messages.

data.mms_transcoding

boolean

default:false

enables automated resizing of MMS media.

data.name

string

A user friendly name for the messaging profile.

data.enabled

boolean

Specifies whether the messaging profile is enabled or not.

data.webhook_url

string<url> | null

The URL where webhooks related to this messaging profile will be sent.

data.webhook_failover_url

string<url> | null

The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.

data.webhook_api_version

enum<string>

Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.

Available options:

1,

2,

2010-04-01

data.whitelisted_destinations

string[]

Destinations to which the messaging profile is allowed to send. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

ISO 3166-1 alpha-2 country code.

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.v1_secret

string

Secret used to authenticate with v1 endpoints.

data.number_pool_settings

object

Number Pool allows you to send messages from a pool of numbers of different types, assigning weights to each type. The pool consists of all the long code and toll free numbers assigned to the messaging profile.

To disable this feature, set the object field to null.

Show child attributes

data.number_pool_settings.toll_free_weight

number

required

Defines the probability weight for a Toll Free number to be selected when sending a message. The higher the weight the higher the probability. The sum of the weights for all number types does not necessarily need to add to 100. Weight must be a non-negative number, and when equal to zero it will remove the number type from the pool.

Example:

10

data.number_pool_settings.long_code_weight

number

required

Defines the probability weight for a Long Code number to be selected when sending a message. The higher the weight the higher the probability. The sum of the weights for all number types does not necessarily need to add to 100. Weight must be a non-negative number, and when equal to zero it will remove the number type from the pool.

Example:

1

data.number_pool_settings.skip_unhealthy

boolean

required

If set to true all unhealthy numbers will be automatically excluded from the pool. Health metrics per number are calculated on a regular basis, taking into account the deliverability rate and the amount of messages marked as spam by upstream carriers. Numbers with a deliverability rate below 25% or spam ratio over 75% will be considered unhealthy.

Example:

true

data.number_pool_settings.sticky_sender

boolean

default:false

If set to true, Number Pool will try to choose the same sending number for all messages to a particular recipient. If the sending number becomes unhealthy and skip_unhealthy is set to true, a new number will be chosen.

data.number_pool_settings.geomatch

boolean

default:false

If set to true, Number Pool will try to choose a sending number with the same area code as the destination number. If there are no such numbers available, a nunber with a different area code will be chosen. Currently only NANP numbers are supported.

Example:

{
  "toll_free_weight": 10,
  "long_code_weight": 1,
  "skip_unhealthy": true,
  "sticky_sender": false,
  "geomatch": false
}

data.url_shortener_settings

object

The URL shortener feature allows automatic replacement of URLs that were generated using a public URL shortener service. Some examples include bit.do, bit.ly, goo.gl, ht.ly, is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com. Such URLs are replaced with with links generated by Telnyx. The use of custom links can improve branding and message deliverability.

To disable this feature, set the object field to null.

Show child attributes

data.url_shortener_settings.domain

string

required

One of the domains provided by the Telnyx URL shortener service.

Example:

"acct.fyi"

data.url_shortener_settings.prefix

string

Optional prefix that can be used to identify your brand, and will appear in the Telnyx generated URLs after the domain name.

Example:

""

data.url_shortener_settings.replace_blacklist_only

boolean

Use the link replacement tool only for links that are specifically blacklisted by Telnyx.

Example:

true

data.url_shortener_settings.send_webhooks

boolean

Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile.

Example:

false

Example:

{
  "domain": "example.ex",
  "prefix": "",
  "replace_blacklist_only": true,
  "send_webhooks": false
}

data.alpha_sender

string | null

The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.

data.daily_spend_limit

string

The maximum amount of money (in USD) that can be spent by this profile before midnight UTC.

data.daily_spend_limit_enabled

boolean

Whether to enforce the value configured by daily_spend_limit.

data.mobile_only

boolean

Send messages only to mobile phone numbers.

Example:

{
  "record_type": "messaging_profile",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Profile for Messages",
  "webhook_url": "https://www.example.com/hooks",
  "webhook_failover_url": "https://backup.example.com/hooks",
  "enabled": true,
  "webhook_api_version": "2",
  "whitelisted_destinations": ["US"],
  "created_at": "2019-01-23T18:10:02.574Z",
  "updated_at": "2019-01-23T18:10:02.574Z",
  "number_pool_settings": {
    "toll_free_weight": 10,
    "long_code_weight": 2,
    "skip_unhealthy": false,
    "sticky_sender": true,
    "geomatch": false
  },
  "url_shortener_settings": {
    "domain": "example.ex",
    "prefix": "cmpny",
    "replace_blacklist_only": true,
    "send_webhooks": false
  },
  "v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
  "health_webhook_url": null,
  "mms_fall_back_to_sms": false,
  "mms_transcoding": false,
  "daily_spend_limit": "100.00",
  "daily_spend_limit_enabled": false,
  "redaction_enabled": false,
  "redaction_level": 2,
  "mobile_only": false
}

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