Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.21 KB

MessagingProfile.md

File metadata and controls

44 lines (28 loc) · 2.21 KB

MessagingProfile

Properties

Name Type Description Notes
recordType RecordTypeEnum Identifies the type of the resource. [optional] [readonly]
id UUID Identifies the type of resource. [optional] [readonly]
name String A user friendly name for the messaging profile. [optional]
enabled Boolean Specifies whether the messaging profile is enabled or not. [optional]
webhookUrl String The URL where webhooks related to this messaging profile will be sent. [optional]
webhookFailoverUrl String The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails. [optional]
webhookApiVersion WebhookApiVersionEnum Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format. [optional]
whitelistedDestinations List<String> Destinations to which the messaging profile is allowed to send. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `[&quot;*&quot;]`, all destinations will be allowed. [optional]
createdAt OffsetDateTime ISO 8601 formatted date indicating when the resource was created. [optional] [readonly]
updatedAt OffsetDateTime ISO 8601 formatted date indicating when the resource was updated. [optional] [readonly]
v1Secret String Secret used to authenticate with v1 endpoints. [optional]
numberPoolSettings NumberPoolSettings [optional]
urlShortenerSettings UrlShortenerSettings [optional]
alphaSender String The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID. [optional]

Enum: RecordTypeEnum

Name Value
MESSAGING_PROFILE "messaging_profile"

Enum: WebhookApiVersionEnum

Name Value
_1 "1"
_2 "2"
_2010_04_01 "2010-04-01"