Skip to main content
GET
/
messaging_profiles
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 messagingProfile of client.messagingProfiles.list()) {
  console.log(messagingProfile.id);
}
{
  "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.

Query Parameters

​
filter
object

Consolidated filter parameter (deepObject style). Originally: filter[name]

​
page
object

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

​
filter[name][eq]
string

Filter profiles by exact name match.

​
filter[name][contains]
string

Filter profiles by name containing the given string.

Response

Successful response with a list of messaging profiles.

​
data
object[]
​
meta
object