Class: Telnyx::Models::MessagingProfile

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/messaging_profile.rb

Overview

See Also:

Defined Under Namespace

Modules: RecordType, WebhookAPIVersion

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::MessagingProfile for more details.

Parameters:

  • id (String) (defaults to: nil) —

    Identifies the type of resource.

  • alpha_sender (String, nil) (defaults to: nil) —

    The alphanumeric sender ID to use when sending to destinations that require an a

  • created_at (Time) (defaults to: nil) —

    ISO 8601 formatted date indicating when the resource was created.

  • daily_spend_limit (String) (defaults to: nil) —

    The maximum amount of money (in USD) that can be spent by this profile before mi

  • daily_spend_limit_enabled (Boolean) (defaults to: nil) —

    Whether to enforce the value configured by ‘daily_spend_limit`.

  • enabled (Boolean) (defaults to: nil) —

    Specifies whether the messaging profile is enabled or not.

  • health_webhook_url (String, nil) (defaults to: nil) —

    DEPRECATED: health check url service checking

  • mms_fall_back_to_sms (Boolean) (defaults to: nil) —

    enables SMS fallback for MMS messages.

  • mms_transcoding (Boolean) (defaults to: nil) —

    enables automated resizing of MMS media.

  • mobile_only (Boolean) (defaults to: nil) —

    Send messages only to mobile phone numbers.

  • name (String) (defaults to: nil) —

    A user friendly name for the messaging profile.

  • number_pool_settings (Telnyx::Models::NumberPoolSettings, nil) (defaults to: nil) —

    Number Pool allows you to send messages from a pool of numbers of different type

  • record_type (Symbol, Telnyx::Models::MessagingProfile::RecordType) (defaults to: nil) —

    Identifies the type of the resource.

  • redaction_enabled (Boolean) (defaults to: nil) —

    Indicates whether message content redaction is enabled for this profile.

  • redaction_level (Integer) (defaults to: nil) —

    Determines how much information is redacted in messages for privacy or complianc

  • smart_encoding (Boolean) (defaults to: nil) —

    Enables automatic character encoding optimization for SMS messages. When enabled

  • updated_at (Time) (defaults to: nil) —

    ISO 8601 formatted date indicating when the resource was updated.

  • url_shortener_settings (Telnyx::Models::URLShortenerSettings, nil) (defaults to: nil) —

    The URL shortener feature allows automatic replacement of URLs that were generat

  • v1_secret (String) (defaults to: nil) —

    Secret used to authenticate with v1 endpoints.

  • webhook_api_version (Symbol, Telnyx::Models::MessagingProfile::WebhookAPIVersion) (defaults to: nil) —

    Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 201

  • webhook_failover_url (String, nil) (defaults to: nil) —

    The failover URL where webhooks related to this messaging profile will be sent i

  • webhook_url (String, nil) (defaults to: nil) —

    The URL where webhooks related to this messaging profile will be sent.

  • whitelisted_destinations (Array<String>) (defaults to: nil) —

    Destinations to which the messaging profile is allowed to send. The elements in




# File 'lib/telnyx/models/messaging_profile.rb', line 166

Instance Attribute Details

#alpha_sender ⇒ String?

The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.

Returns:

  • (String, nil) 


12
 
# File 'lib/telnyx/models/messaging_profile.rb', line 12

optional :alpha_sender, String, nil?: true

#daily_spend_limit ⇒ String?

The maximum amount of money (in USD) that can be spent by this profile before midnight UTC.

Returns:

  • (String, nil) 


19
 
# File 'lib/telnyx/models/messaging_profile.rb', line 19

optional :daily_spend_limit, String

#daily_spend_limit_enabled ⇒ Boolean?

Whether to enforce the value configured by ‘daily_spend_limit`.

Returns:

  • (Boolean, nil) 


25
 
# File 'lib/telnyx/models/messaging_profile.rb', line 25

optional :daily_spend_limit_enabled, Telnyx::Internal::Type::Boolean

#enabled ⇒ Boolean?

Specifies whether the messaging profile is enabled or not.

Returns:

  • (Boolean, nil) 


31
 
# File 'lib/telnyx/models/messaging_profile.rb', line 31

optional :enabled, Telnyx::Internal::Type::Boolean

#health_webhook_url ⇒ String?

DEPRECATED: health check url service checking

Returns:

  • (String, nil) 


37
 
# File 'lib/telnyx/models/messaging_profile.rb', line 37

optional :health_webhook_url, String, nil?: true

#mms_fall_back_to_sms ⇒ Boolean?

enables SMS fallback for MMS messages.

Returns:

  • (Boolean, nil) 


43
 
# File 'lib/telnyx/models/messaging_profile.rb', line 43

optional :mms_fall_back_to_sms, Telnyx::Internal::Type::Boolean

#mms_transcoding ⇒ Boolean?

enables automated resizing of MMS media.

Returns:

  • (Boolean, nil) 


49
 
# File 'lib/telnyx/models/messaging_profile.rb', line 49

optional :mms_transcoding, Telnyx::Internal::Type::Boolean

#mobile_only ⇒ Boolean?

Send messages only to mobile phone numbers.

Returns:

  • (Boolean, nil) 


55
 
# File 'lib/telnyx/models/messaging_profile.rb', line 55

optional :mobile_only, Telnyx::Internal::Type::Boolean

#name ⇒ String?

A user friendly name for the messaging profile.

Returns:

  • (String, nil) 


61
 
# File 'lib/telnyx/models/messaging_profile.rb', line 61

optional :name, String

#number_pool_settings ⇒ Telnyx::Models::NumberPoolSettings?

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`.

Returns:



71
 
# File 'lib/telnyx/models/messaging_profile.rb', line 71

optional :number_pool_settings, -> { Telnyx::NumberPoolSettings }, nil?: true

#redaction_enabled ⇒ Boolean?

Indicates whether message content redaction is enabled for this profile.

Returns:

  • (Boolean, nil) 


77
 
# File 'lib/telnyx/models/messaging_profile.rb', line 77

optional :redaction_enabled, Telnyx::Internal::Type::Boolean

#redaction_level ⇒ Integer?

Determines how much information is redacted in messages for privacy or compliance purposes.

Returns:

  • (Integer, nil) 


84
 
# File 'lib/telnyx/models/messaging_profile.rb', line 84

optional :redaction_level, Integer

#smart_encoding ⇒ Boolean?

Enables automatic character encoding optimization for SMS messages. When enabled, the system automatically selects the most efficient encoding (GSM-7 or UCS-2) based on message content to maximize character limits and minimize costs.

Returns:

  • (Boolean, nil) 


92
 
# File 'lib/telnyx/models/messaging_profile.rb', line 92

optional :smart_encoding, Telnyx::Internal::Type::Boolean

#url_shortener_settings ⇒ Telnyx::Models::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`.

Returns:



104
 
# File 'lib/telnyx/models/messaging_profile.rb', line 104

optional :url_shortener_settings, -> { Telnyx::URLShortenerSettings }, nil?: true

#v1_secret ⇒ String?

Secret used to authenticate with v1 endpoints.

Returns:

  • (String, nil) 


110
 
# File 'lib/telnyx/models/messaging_profile.rb', line 110

optional :v1_secret, String

#webhook_api_version ⇒ Symbol, ...

Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.

Returns:



117
 
# File 'lib/telnyx/models/messaging_profile.rb', line 117

optional :webhook_api_version, enum: -> { Telnyx::MessagingProfile::WebhookAPIVersion }

#webhook_failover_url ⇒ String?

The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.

Returns:

  • (String, nil) 


124
 
# File 'lib/telnyx/models/messaging_profile.rb', line 124

optional :webhook_failover_url, String, nil?: true

#webhook_url ⇒ String?

The URL where webhooks related to this messaging profile will be sent.

Returns:

  • (String, nil) 


130
 
# File 'lib/telnyx/models/messaging_profile.rb', line 130

optional :webhook_url, String, nil?: true

#whitelisted_destinations ⇒ Array<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 ‘[“*”]`, all destinations will be allowed.

Returns:

  • (Array<String>, nil) 


138
 
# File 'lib/telnyx/models/messaging_profile.rb', line 138

optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/messaging_profile.rb', line 224