Class: Aws::PinpointSMSVoiceV2::Types::SendVoiceMessageRequest

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::SendVoiceMessageRequest

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.

• #max_price_per_minute ⇒ String

  The maximum amount to spend per voice message, in US dollars.

• #message_body ⇒ String

  The text to convert to a voice message.

• #message_body_text_type ⇒ String

  Specifies if the MessageBody field contains text or [speech synthesis markup language (SSML)][1].

• #origination_identity ⇒ String

  The origination identity to use for the voice call.

• #protect_configuration_id ⇒ String

  The unique identifier for the protect configuration.

• #time_to_live ⇒ Integer

  How long the voice message is valid for.

• #voice_id ⇒ String

  The voice for the [Amazon Polly][1] service to use.

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 5647

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  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 5647

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  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 5647

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  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 5647

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_price_per_minute ⇒ String

The maximum amount to spend per voice message, in US dollars.

Returns:

• (String)

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

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end

#message_body ⇒ String

The text to convert to a voice message.

Returns:

• (String)

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

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end

#message_body_text_type ⇒ String

Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

• TEXT: This is the default value. When used the maximum character limit is 3000.

• SSML: When used the maximum character limit is 6000 including SSML tagging.

Returns:

• (String)

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

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identity ⇒ String

The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

Returns:

• (String)

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

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end

#protect_configuration_id ⇒ String

The unique identifier for the protect configuration.

Returns:

• (String)

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

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end

#time_to_live ⇒ Integer

How long the voice message is valid for. By default this is 72 hours.

Returns:

• (Integer)

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

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end

#voice_id ⇒ String

The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

Returns:

• (String)

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

class SendVoiceMessageRequest < Struct.new(
  :destination_phone_number,
  :origination_identity,
  :message_body,
  :message_body_text_type,
  :voice_id,
  :configuration_set_name,
  :max_price_per_minute,
  :time_to_live,
  :context,
  :dry_run,
  :protect_configuration_id)
  SENSITIVE = []
  include Aws::Structure
end