This is the current API V1 documentation. Explore our API V2 beta if you’d like to test new features.

Docs
Choose:
cURLPython
cURLPython

Alphanumeric Sender IDalphanumeric-sender-id

An Alphanumeric Sender ID lets you send messages using a custom ID constructed from a combination of alpha (a-z, A-Z) and numeric (0-9) characters as well as spaces. This makes the sender identifiable to the receiver, as companies can set their brand name as the ID (e.g., TELNYX). It's commonly used for sending one-way text messages, as the person receiving the message will be unable to reply with an Alphanumeric Sender ID.

Note: Each country regulates alphanumeric sender ID differently. Ensure that you're complying with the local regulations.

When sending messages, use the send message endpointAPI. Instead of specifying a phone number as the “From” field, provide the Alphanumeric Sender ID. You will also need to specify the Messaging Profile (via the messaging_profile_id parameter) that will be used to send the message.

Note: Telnyx attempts to deliver your message whenever possible. If you use a sending number that is unable to deliver the message, Telnyx will failover to using an generic alphanumeric sender ID to terminate the message.

Using the Telnyx APIusing-the-telnyx-api

curl -X PATCH \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "x-api-token: YOUR_TELNYX_API_TOKEN" \
  --header "x-api-user: YOUR_TELNYX_API_USER" \
  --data '{"alpha_sender":"Telnyx"}' \
  "https://api.telnyx.com/messaging/profiles/{YOUR_MESSAGING_PROFILE_UUID}"