Creates a new messaging profile.
In order to use the Telnyx Messaging Services, at least one of your
Telnyx SMS-enabled phone numbers needs to be assigned to an
existing messaging profile.
Request
Request Body schema: application/json
required
name
required
string
Name/description of messaging profile
incoming_webhook_url
string
Default: ""
The URL where webhooks for inbound messages to numbers on this messaging profile will be sent. (Previously called "url".)
incoming_failover_url
string
Default: ""
The failover URL where webhooks for inbound messages to numbers on this messaging profile will be sent, if sending to the primary URL fails. (Previously called "failover_url".)
webhook_api_version
string
Default: "1"
Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.
Enum:"1""2""2010-04-01"
whitelisted_destinations
Array of strings
Default: null
Destinations to which the messaging profile is allowed to send. If set to null, all destinations will be allowed. Setting a value of ["*"] has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes.
alpha_sender
string^[A-Za-z0-9 ]{1,11}$
Default: ""
DEPRECATED: Alphanumeric Sender IDs can be set dynamically in the /messages request.
object (NumberPoolSettings)
Default: null
Number Pool allows you to send messages from a pool of numbers of different types, assigning
weights to each type. The pool consists of all the long code and toll free numbers
assigned to the messaging profile.
To disable this feature, set the object field to null.
object (UrlShortenerSettings)
Default: null
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.