Class: Telnyx::Models::MessageSendWithAlphanumericSenderParams

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

Overview

See Also:

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(from:, messaging_profile_id:, text:, to:, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {}) ⇒ Object

Parameters:

  • from (String) —

    A valid alphanumeric sender ID on the user’s account.

  • messaging_profile_id (String) —

    The messaging profile ID to use.

  • text (String) —

    The message body.

  • to (String) —

    Receiving address (+E.164 formatted phone number).

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

    If true, use the messaging profile’s webhook settings.

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

    Failover callback URL for delivery status updates.

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

    Callback URL for delivery status updates.

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



# File 'lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb', line 52

Instance Attribute Details

#from ⇒ String

A valid alphanumeric sender ID on the user’s account.

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb', line 14

required :from, String

#messaging_profile_id ⇒ String

The messaging profile ID to use.

Returns:

  • (String) 


20
 
# File 'lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb', line 20

required :messaging_profile_id, String

#text ⇒ String

The message body.

Returns:

  • (String) 


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

required :text, String

#to ⇒ String

Receiving address (+E.164 formatted phone number).

Returns:

  • (String) 


32
 
# File 'lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb', line 32

required :to, String

#use_profile_webhooks ⇒ Boolean?

If true, use the messaging profile’s webhook settings.

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb', line 38

optional :use_profile_webhooks, Telnyx::Internal::Type::Boolean

#webhook_failover_url ⇒ String?

Failover callback URL for delivery status updates.

Returns:

  • (String, nil) 


44
 
# File 'lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb', line 44

optional :webhook_failover_url, String, nil?: true

#webhook_url ⇒ String?

Callback URL for delivery status updates.

Returns:

  • (String, nil) 


50
 
# File 'lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb', line 50

optional :webhook_url, String, nil?: true