Telnyx Notifications

Overview

• Source: https://telnyx.com
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 160
• Supported Body Format(s):
  • ✓TEXT
• Build Your Apprise URL

Account Setup

1. Sign up for an account at telnyx.com.
2. Buy a phone number from the Numbers section of the Mission Control Portal.
3. Create a Messaging Profile and assign your phone number to it. A number cannot send messages until it belongs to a profile.
4. Generate a V2 API Key from the API Keys page and copy it somewhere safe. This is the only time it is shown to you.

Your API key and the phone number you bought are everything you need to start sending.

Syntax

Valid syntax is as follows:

• telnyx://{apikey}@{fromPhoneNo}
• telnyx://{apikey}@{fromPhoneNo}/{toPhoneNo}
• telnyx://{apikey}@{fromPhoneNo}/{toPhoneNo1}/{toPhoneNo2}/{toPhoneNoN}

If you do not provide a destination number, Apprise sends the message back to the number it was sent from. This is handy for testing.

Parameter Breakdown

Variable	Required	Description
apikey	*Yes	The V2 API Key generated from your Telnyx Mission Control Portal.
fromPhoneNo	*Yes	The Telnyx phone number the message is sent from. It must be assigned to a Messaging Profile.
toPhoneNo	No	One or more destination phone numbers. Separate multiple numbers with a / in the URL path. If you leave this out, the message goes back to fromPhoneNo.
to	No	Alias for the destination phone numbers. Accepts a comma-separated list and can be combined with numbers already in the URL path.
from	No	Alias for fromPhoneNo. Useful in YAML configuration files where you would rather keep the number on its own line.
key	No	Alias for apikey. Useful in YAML configuration files.
profile	No	The Messaging Profile ID to send through. Only needed when your number belongs to more than one profile and you want to pick a specific one.

Global Parameters

Variable	Description
overflow	Controls messages that exceed a service’s documented limit. The default is upstream. 👉 upstream: Send one message without splitting or truncating it for that limit. 👉 truncate: Keep the portion that fits and discard the rest. 👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order. Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
redirect	By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.
retry	The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
wait	The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value.
optional	When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still evaluates as true even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Examples

Send a message to yourself (the from number is also the destination):

# Assuming our API Key is KEY0123456789abcdef
# Assuming our Telnyx phone number is +1-405-123-1234
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "telnyx://KEY0123456789abcdef@+14051231234"

Send a message to someone else:

apprise -vv -t "Alert" -b "The backup job failed" \
   "telnyx://KEY0123456789abcdef@+14051231234/+15551231234"

Send to several people at once:

apprise -vv -b "Server is down" \
   "telnyx://KEY0123456789abcdef@+14051231234/+15551231234/+15559876543"

Send through a specific Messaging Profile:

apprise -vv -b "Nightly report ready" \
   "telnyx://KEY0123456789abcdef@+14051231234/+15551231234?profile=40017b3c-1234-5678-9abc-def012345678"

Use query parameters instead of building the numbers into the URL. This reads nicely in a YAML configuration file:

apprise -vv -b "Hello world" \
   "telnyx://?key=KEY0123456789abcdef&from=+14051231234&to=+15551231234,+15559876543"