Class: Aws::PinpointSMSVoiceV2::Types::SendRcsMessageRequest

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::SendRcsMessageRequest

Defined in:

gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration_set_name ⇒ String

  The name of the configuration set to use.

• #context ⇒ Hash<String,String>

  You can specify custom data in this field.

• #destination_phone_number ⇒ String

  The destination phone number in E.164 format.

• #dry_run ⇒ Boolean

  When set to true, the message is checked and validated, but isn't sent to the end recipient.

• #fallback_configuration ⇒ Types::RcsFallbackConfiguration

  Configuration for SMS or MMS fallback when RCS delivery fails.

• #max_price ⇒ String

  The maximum amount that you want to spend, in US dollars, per each RCS message.

• #message_feedback_enabled ⇒ Boolean

  Set to true to enable message feedback for the message.

• #message_traffic_type ⇒ String

  The traffic type of the RCS message.

• #origination_identity ⇒ String

  The origination identity of the message.

• #protect_configuration_id ⇒ String

  The unique identifier of the protect configuration to use.

• #rcs_message_content ⇒ Types::RcsMessageContent

  The content of the RCS message.

• #time_to_live ⇒ Integer

  The duration in seconds that the RCS message is valid for delivery.

Instance Attribute Details

#configuration_set_name ⇒ String

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ Hash<String,String>

You can specify custom data in this field. If you do, that data is logged to the event destination.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#destination_phone_number ⇒ String

The destination phone number in E.164 format.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

When set to true, the message is checked and validated, but isn't sent to the end recipient.

Returns:

• (Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#fallback_configuration ⇒ Types::RcsFallbackConfiguration

Configuration for SMS or MMS fallback when RCS delivery fails. If provided, the service sends a fallback message via the specified channel when the RCS message fails or the TimeToLive expires.

Returns:

• (Types::RcsFallbackConfiguration)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#max_price ⇒ String

The maximum amount that you want to spend, in US dollars, per each RCS message.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#message_feedback_enabled ⇒ Boolean

Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

Returns:

• (Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#message_traffic_type ⇒ String

The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identity ⇒ String

The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#protect_configuration_id ⇒ String

The unique identifier of the protect configuration to use.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#rcs_message_content ⇒ Types::RcsMessageContent

The content of the RCS message. Contains the message content (text, file, rich card, or carousel) and optional message-level suggested actions.

Returns:

• (Types::RcsMessageContent)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#time_to_live ⇒ Integer

The duration in seconds that the RCS message is valid for delivery. If the message cannot be delivered within this duration, it is considered expired. Valid values are 1 to 172800 (48 hours). If a FallbackConfiguration is provided, the fallback is triggered when the duration expires without delivery confirmation.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 8555

class SendRcsMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :rcs_message_content,
  :time_to_live,
  :message_traffic_type,
  :fallback_configuration,
  :protect_configuration_id,
  :configuration_set_name,
  :max_price,
  :dry_run,
  :context,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end