Class: Telnyx::Models::MessagingProfileUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/messaging_profile_update_params.rb,
sig/telnyx/models/messaging_profile_update_params.rbs

Overview

See Also:

  • Telnyx::Resources::MessagingProfiles#update

Defined Under Namespace

Modules: WebhookAPIVersion

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {}) ⇒ Object

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

Parameters:

  • messaging_profile_id (String)
  • ai_assistant_id (String, nil) (defaults to: nil) —

    The ID of the AI assistant associated with this messaging profile.

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

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

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

  • 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

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

    Set to true to enable message content redaction on this profile, or false to dis

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

    The redaction level to apply when redaction is enabled. 1: redact message record

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

    Enables automatic character encoding optimization for SMS messages. When enabled

  • 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::MessagingProfileUpdateParams::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

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 154

Instance Attribute Details

#ai_assistant_id ⇒ String?

The ID of the AI assistant associated with this messaging profile.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :ai_assistant_id, String, nil?: true

#alpha_sender ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


26
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 26

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.

Parameters:

  • (String)

Returns:

  • (String, nil) 


33
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 33

optional :daily_spend_limit, String

#daily_spend_limit_enabled ⇒ Boolean?

Whether to enforce the value configured by daily_spend_limit.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


39
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 39

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

#enabled ⇒ Boolean?

Specifies whether the messaging profile is enabled or not.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


45
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 45

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

#messaging_profile_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 13

required :messaging_profile_id, String

#mms_fall_back_to_sms ⇒ Boolean?

enables SMS fallback for MMS messages.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


51
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 51

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

#mms_transcoding ⇒ Boolean?

enables automated resizing of MMS media.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


57
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 57

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

#mobile_only ⇒ Boolean?

Send messages only to mobile phone numbers.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


63
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 63

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

#name ⇒ String?

A user friendly name for the messaging profile.

Parameters:

  • (String)

Returns:

  • (String, nil) 


69
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 69

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.

Parameters:

Returns:



79
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 79

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

#redaction_enabled ⇒ Boolean?

Set to true to enable message content redaction on this profile, or false to disable it. Ignored if the organization is not on the redaction allowlist. See the Message Redaction guide for what is redacted.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


88
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 88

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

#redaction_level ⇒ Integer?

The redaction level to apply when redaction is enabled. 1: redact message records and reporting only. 2 (default): also redact inbound webhook payloads. See the Message Redaction guide.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


96
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 96

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.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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.

Parameters:

Returns:



116
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 116

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

#v1_secret ⇒ String?

Secret used to authenticate with v1 endpoints.

Parameters:

  • (String)

Returns:

  • (String, nil) 


122
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 122

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:



129
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 129

optional :webhook_api_version, enum: -> { Telnyx::MessagingProfileUpdateParams::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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


136
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 136

optional :webhook_failover_url, String, nil?: true

#webhook_url ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


142
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 142

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.

This field is required if the messaging profile doesn't have it defined yet.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


152
 
# File 'lib/telnyx/models/messaging_profile_update_params.rb', line 152

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


124
 
# File 'sig/telnyx/models/messaging_profile_update_params.rbs', line 124

def to_hash: -> {