Telnyx


Schemes	`telnyx://`
Cargo feature	`service-telnyx`
Service	https://telnyx.com
Body formats	`text` (first is the default)
Attachments	no
Title length	no title (merged into the body)
Body length	160 characters
Body lines	unlimited
Request throttle	none
Vendor URLs accepted	no

URL formats

{schema}://{apikey}@{from_phone}
{schema}://{apikey}@{from_phone}/{targets}

{schema} is one of telnyx://.

URL tokens

Token	Meaning	Type	Required	Notes
`{apikey}`	API Key	string	yes	secret
`{from_phone}`	From Phone No	string	yes	must match `^\+?[0-9\s)(+-]+$`
`{target_phone}`	Target Phone No	string	no	prefix `+`; must match `^[0-9\s)(+-]+$`
`{targets}`	Targets	list	yes	any of `target_phone`; separated by `/`

Query parameters

Parameter	Meaning	Type	Notes
`from`	From Phone No	string	must match `^\+?[0-9\s)(+-]+$`
`key`	API Key	string	sets `{apikey}`
`profile`	Messaging Profile ID	string
`to`	Targets	list	sets `{targets}`

The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.

Examples

Accepted URLs (tokens are fake):

telnyx://apikey@15551232000
telnyx://apikey@15551232000/15551232001/+1 555 123 2002
telnyx://apikey@15551232000?profile=prof-123
telnyx://apikey@15551232001/15551232002?from=15551232000
telnyx://15551232000?key=thekey&to=15551232001

Rejected URLs:

telnyx://
telnyx://15551232000
telnyx://apikey@123
telnyx://apikey@15551232001?from=abc

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'telnyx://apikey@15551232000'

Notes

Telnyx (telnyx://): SMS through the Telnyx API.