Skip to content

Latest commit

 

History

History
17 lines (9 loc) · 1.13 KB

UrlShortenerSettings.md

File metadata and controls

17 lines (9 loc) · 1.13 KB

UrlShortenerSettings

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.

Properties

Name Type Description Notes
domain String 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. [optional]
replaceBlacklistOnly Boolean Use the link replacement tool only for links that are specifically blacklisted by Telnyx. [optional]
sendWebhooks Boolean Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile. [optional]