Class: Telnyx::Models::OutboundMessagePayload

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::OutboundMessagePayload

Defined in:

lib/telnyx/models/outbound_message_payload.rb

Defined Under Namespace

Modules: Direction, RecordType, Type Classes: Cc, Cost, CostBreakdown, From, Media, To

Instance Attribute Summary

• #cc ⇒ Array<Telnyx::Models::OutboundMessagePayload::Cc>^?
• #completed_at ⇒ Time^?

  ISO 8601 formatted date indicating when the message was finalized.

• #cost ⇒ Telnyx::Models::OutboundMessagePayload::Cost^?
• #cost_breakdown ⇒ Telnyx::Models::OutboundMessagePayload::CostBreakdown^?

  Detailed breakdown of the message cost components.

• #direction ⇒ Symbol, ...

  The direction of the message.

• #encoding ⇒ String^?

  Encoding scheme used for the message body.

• #errors ⇒ Array<Telnyx::Models::MessagingError>^?

  These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

• #from ⇒ Telnyx::Models::OutboundMessagePayload::From^?
• #id ⇒ String^?

  Identifies the type of resource.

• #media ⇒ Array<Telnyx::Models::OutboundMessagePayload::Media>^?
• #messaging_profile_id ⇒ String^?

  Unique identifier for a messaging profile.

• #organization_id ⇒ String^?

  The id of the organization the messaging profile belongs to.

• #parts ⇒ Integer^?

  Number of parts into which the message’s body must be split.

• #received_at ⇒ Time^?

  ISO 8601 formatted date indicating when the message request was received.

• #record_type ⇒ Symbol, ...

  Identifies the type of the resource.

• #sent_at ⇒ Time^?

  ISO 8601 formatted date indicating when the message was sent.

• #smart_encoding_applied ⇒ Boolean^?

  Indicates whether smart encoding was applied to this message.

• #subject ⇒ String^?

  Subject of multimedia message.

• #tags ⇒ Array<String>^?

  Tags associated with the resource.

• #tcr_campaign_billable ⇒ Boolean^?

  Indicates whether the TCR campaign is billable.

• #tcr_campaign_id ⇒ String^?

  The Campaign Registry (TCR) campaign ID associated with the message.

• #tcr_campaign_registered ⇒ String^?

  The registration status of the TCR campaign.

• #text ⇒ String^?

  Message body (i.e., content) as a non-empty string.

• #to ⇒ Array<Telnyx::Models::OutboundMessagePayload::To>^?
• #type ⇒ Symbol, ...

  The type of message.

• #valid_until ⇒ Time^?

  Message must be out of the queue by this time or else it will be discarded and marked as ‘sending_failed’.

• #wait_seconds ⇒ Float^?

  Seconds the message is queued due to rate limiting before being sent to the carrier.

• #webhook_failover_url ⇒ String^?

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

• #webhook_url ⇒ String^?

  The URL where webhooks related to this message will be sent.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(content_type: nil, sha256: nil, size: nil, url: nil) ⇒ Object constructor

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(content_type: nil, sha256: nil, size: nil, url: nil) ⇒ Object

Parameters:

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

  The MIME type of the requested media.

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

  The SHA256 hash of the requested media.

• size (Integer, nil) (defaults to: nil) —

  The size of the requested media.

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

  The url of the media requested to be sent.

# File 'lib/telnyx/models/outbound_message_payload.rb', line 330

Instance Attribute Details

#cc ⇒ Array<Telnyx::Models::OutboundMessagePayload::Cc>^?

Returns:

• (Array<Telnyx::Models::OutboundMessagePayload::Cc>, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 15

optional :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::OutboundMessagePayload::Cc] }

#completed_at ⇒ Time^?

ISO 8601 formatted date indicating when the message was finalized.

Returns:

• (Time, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 21

optional :completed_at, Time, nil?: true

#cost ⇒ Telnyx::Models::OutboundMessagePayload::Cost^?

Returns:

• (Telnyx::Models::OutboundMessagePayload::Cost, nil)

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

optional :cost, -> { Telnyx::OutboundMessagePayload::Cost }, nil?: true

#cost_breakdown ⇒ Telnyx::Models::OutboundMessagePayload::CostBreakdown^?

Detailed breakdown of the message cost components.

Returns:

• (Telnyx::Models::OutboundMessagePayload::CostBreakdown, nil)

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

optional :cost_breakdown, -> { Telnyx::OutboundMessagePayload::CostBreakdown }, nil?: true

#direction ⇒ Symbol, ...

The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.

Returns:

• (Symbol, Telnyx::Models::OutboundMessagePayload::Direction, nil)

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

optional :direction, enum: -> { Telnyx::OutboundMessagePayload::Direction }

#encoding ⇒ String^?

Encoding scheme used for the message body.

Returns:

• (String, nil)

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

optional :encoding, String

#errors ⇒ Array<Telnyx::Models::MessagingError>^?

These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

Returns:

• (Array<Telnyx::Models::MessagingError>, nil)

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

optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingError] }

#from ⇒ Telnyx::Models::OutboundMessagePayload::From^?

Returns:

• (Telnyx::Models::OutboundMessagePayload::From, nil)

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

optional :from, -> { Telnyx::OutboundMessagePayload::From }

#id ⇒ String^?

Identifies the type of resource.

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 10

optional :id, String

#media ⇒ Array<Telnyx::Models::OutboundMessagePayload::Media>^?

Returns:

• (Array<Telnyx::Models::OutboundMessagePayload::Media>, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 62

optional :media, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::OutboundMessagePayload::Media] }

#messaging_profile_id ⇒ String^?

Unique identifier for a messaging profile.

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 68

optional :messaging_profile_id, String

#organization_id ⇒ String^?

The id of the organization the messaging profile belongs to.

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 74

optional :organization_id, String

#parts ⇒ Integer^?

Number of parts into which the message’s body must be split.

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 80

optional :parts, Integer

#received_at ⇒ Time^?

ISO 8601 formatted date indicating when the message request was received.

Returns:

• (Time, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 86

optional :received_at, Time

#record_type ⇒ Symbol, ...

Identifies the type of the resource.

Returns:

• (Symbol, Telnyx::Models::OutboundMessagePayload::RecordType, nil)

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

optional :record_type, enum: -> { Telnyx::OutboundMessagePayload::RecordType }

#sent_at ⇒ Time^?

ISO 8601 formatted date indicating when the message was sent.

Returns:

• (Time, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 98

optional :sent_at, Time, nil?: true

#smart_encoding_applied ⇒ Boolean^?

Indicates whether smart encoding was applied to this message. When ‘true`, one or more Unicode characters were automatically replaced with GSM-7 equivalents to reduce segment count and cost. The original message text is preserved in webhooks.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 107

optional :smart_encoding_applied, Telnyx::Internal::Type::Boolean

#subject ⇒ String^?

Subject of multimedia message

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 113

optional :subject, String, nil?: true

#tags ⇒ Array<String>^?

Tags associated with the resource.

Returns:

• (Array<String>, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 119

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

#tcr_campaign_billable ⇒ Boolean^?

Indicates whether the TCR campaign is billable.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 125

optional :tcr_campaign_billable, Telnyx::Internal::Type::Boolean

#tcr_campaign_id ⇒ String^?

The Campaign Registry (TCR) campaign ID associated with the message.

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 131

optional :tcr_campaign_id, String, nil?: true

#tcr_campaign_registered ⇒ String^?

The registration status of the TCR campaign.

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 137

optional :tcr_campaign_registered, String, nil?: true

#text ⇒ String^?

Message body (i.e., content) as a non-empty string.

**Required for SMS**

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 145

optional :text, String

#to ⇒ Array<Telnyx::Models::OutboundMessagePayload::To>^?

Returns:

• (Array<Telnyx::Models::OutboundMessagePayload::To>, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 150

optional :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::OutboundMessagePayload::To] }

#type ⇒ Symbol, ...

The type of message.

Returns:

• (Symbol, Telnyx::Models::OutboundMessagePayload::Type, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 156

optional :type, enum: -> { Telnyx::OutboundMessagePayload::Type }

#valid_until ⇒ Time^?

Message must be out of the queue by this time or else it will be discarded and marked as ‘sending_failed’. Once the message moves out of the queue, this field will be nulled

Returns:

• (Time, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 164

optional :valid_until, Time, nil?: true

#wait_seconds ⇒ Float^?

Seconds the message is queued due to rate limiting before being sent to the carrier. Represents the maximum wait across all applicable rate limits (account, carrier, campaign). 0.0 = no queuing delay.

Returns:

• (Float, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 172

optional :wait_seconds, Float, nil?: true

#webhook_failover_url ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 179

optional :webhook_failover_url, String, nil?: true

#webhook_url ⇒ String^?

The URL where webhooks related to this message will be sent.

Returns:

• (String, nil)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 185

optional :webhook_url, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/outbound_message_payload.rb', line 311