This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuDocs
Docs
Close Sidemenu
Choose:
Mission Control PortalcURLPythonRubyNode
Mission Control PortalcURLPythonRubyNode

URL Shortenerurl-shortener

Telnyx provides a URL Shortening service with custom links in order to improve brand awareness and bypass spam filters that block most popular URL shortening sites. Any message that contains URLs with the supported domains will be converted into one of Telnyx's custom URLs.

How It Workshow-it-works

When URL Shortening is turned on, any messages that contains base URLs from the supported URLs will be converted to a URL with a base domain of your choosing.

For example, if you were to send a message that looked like the following payload object:

{
  ...
  "text": "Your shift is starting soon: https://bit.ly/78ejf9n"
  ...
}

URL Shortening will turn the message into:

{
    ...
    "text": "Your shift is starting soon: http://scdlchg.cc/b20",
    ...
}

Supported Domains in URLssupported-domains-in-urls

By default, if URL Shortening is enabled on the messaging profile, only URLs with the following domains will be converted:

  • bit.do
  • bit.ly
  • carebank.site
  • drvline.site
  • eatngage.com
  • goo.gl
  • healthsettle.pw
  • ht.ly
  • is.gd
  • ow.ly
  • rebrand.ly
  • t.co
  • tiny.cc
  • tinyurl.com
  • x.co

Note: You have the option of expanding the shortening for all domains. You can disable the Replace Blacklist Only setting in the URL Shortener settings on your messaging profile.

Message Engagement Reportsmessage-engagement-reports

In addition to URL shortening, you can also view how often recipients of your messages have opened the link via the Message Engagement ReportPORTAL.

  1. 1Select a Start Date and End Date for the time range you wish to report on.
  2. 2Select the Messaging Profiles you wish to report on.
  3. 3Click on Generate Messaging Report.
  4. 4(Optionally) You can also download a detailed view of the clicks.

If you want to track user engagement with your custom shortened links in real time, you have the option of receiving webhooks when a shortened link is clicked.

You can enable receiving webhooks on a per messaging profile basis. Webhooks will be sent to the webhooks already configured on the messaging profile.

Basic Setupbasic-setup

URL Shortening is enabled per Messaging Profile. If you send SMS via phone numbers under this profile, if they contain any URLs that are part of the list of supported URLs, then they will be replaced with links that the URL Shortener service generates.

  1. 1On the Mission Control Portal, click on to MessagingPORTAL.
  2. 2Select the Messaging Profile you wish to enable URL shortening for.
  3. 3Enable the URL Shortener.

enable url shortener

  1. 4Select the URL you would like to convert your links to.

set url shortener target url

  1. 5(Recommended) You can add a unique identifier to help distinguish your brand.

set brand name

Was this page helpful?was-this-page-helpful