---
title: "Retrieve a messaging profile"
method: GET
path: "/messaging_profiles/{id}"
tags: ["Profiles"]
---

# Retrieve a messaging profile

`GET /messaging_profiles/{id}`

## Path parameters

- `id` string, uuid, required

## Response `200`

Successful response with details about a messaging profile.

- object
  - `data` MessagingProfile
    - `record_type` 'messaging_profile' — Identifies the type of the resource.
    - `id` string, uuid — Identifies the type of resource.
    - `mms_fall_back_to_sms` boolean — enables SMS fallback for MMS messages.
    - `mms_transcoding` boolean — enables automated resizing of MMS media.
    - `name` string — A user friendly name for the messaging profile.
    - `enabled` boolean — Specifies whether the messaging profile is enabled or not.
    - `webhook_url` string, url, nullable — The URL where webhooks related to this messaging profile will be sent.
    - `webhook_failover_url` string, url, nullable — The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.
    - `webhook_api_version` '1' | '2' | '2010-04-01' — Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.
    - `health_webhook_url` string, url, nullable — DEPRECATED: health check url service checking
    - `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.
    - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
    - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
    - `v1_secret` string — Secret used to authenticate with v1 endpoints.
    - `number_pool_settings` NumberPoolSettings, nullable — 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`.
      - `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.
      - `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.
      - `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.
      - `sticky_sender` boolean — 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.
      - `geomatch` boolean — 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.
    - `url_shortener_settings` UrlShortenerSettings, nullable — 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`.
      - `domain` string, required — One of the domains provided by the Telnyx URL shortener service.
      - `prefix` string — Optional prefix that can be used to identify your brand, and will appear in the Telnyx generated URLs after the domain name.
      - `replace_blacklist_only` boolean — Use the link replacement tool only for links that are specifically blacklisted by Telnyx.
      - `send_webhooks` boolean — Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile.
    - `alpha_sender` string, nullable — The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.
    - `daily_spend_limit` string — The maximum amount of money (in USD) that can be spent by this profile before midnight UTC.
    - `daily_spend_limit_enabled` boolean — Whether to enforce the value configured by `daily_spend_limit`.
    - `redaction_enabled` boolean — Indicates whether message content redaction is enabled for this profile.
    - `redaction_level` integer — Determines how much information is redacted in messages for privacy or compliance purposes.
    - `mobile_only` boolean — Send messages only to mobile phone numbers.
    - `smart_encoding` boolean — Enables automatic character encoding optimization for SMS messages. When enabled, the system automatically selects the most efficient encoding (GSM-7 or UCS-2) based on message content to maximize character limits and minimize costs.
    - `organization_id` string — The organization that owns this messaging profile.
    - `ai_assistant_id` string, nullable — The AI assistant ID associated with this messaging profile.
    - `resource_group_id` string, nullable — The resource group ID associated with this messaging profile.

## Other responses

- `4XX` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)