Class: Aws::EndUserMessaging::Types::VoiceParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb

Overview

The delivery parameters for the voice channel.

See Also:

Constant Summary collapse

SENSITIVE = 
[:inline_template_body]

Instance Attribute Summary collapse

Instance Attribute Details

#inline_template_body ⇒ String

The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.

Returns:

  • (String) 


2218
2219
2220
2221
2222
2223
2224
2225
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 2218

class VoiceParameters < Struct.new(
  :inline_template_body,
  :language_code,
  :voice_id,
  :voice_message_body_text_type)
  SENSITIVE = [:inline_template_body]
  include Aws::Structure
end

#language_code ⇒ String

The BCP 47 language code used to render the voice message.

Returns:

  • (String) 


2218
2219
2220
2221
2222
2223
2224
2225
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 2218

class VoiceParameters < Struct.new(
  :inline_template_body,
  :language_code,
  :voice_id,
  :voice_message_body_text_type)
  SENSITIVE = [:inline_template_body]
  include Aws::Structure
end

#voice_id ⇒ String

The Amazon Polly voice ID used for the voice channel.

Returns:

  • (String) 


2218
2219
2220
2221
2222
2223
2224
2225
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 2218

class VoiceParameters < Struct.new(
  :inline_template_body,
  :language_code,
  :voice_id,
  :voice_message_body_text_type)
  SENSITIVE = [:inline_template_body]
  include Aws::Structure
end

#voice_message_body_text_type ⇒ String

The format of the voice message body. Valid values are TEXT and SSML.

Returns:

  • (String) 


2218
2219
2220
2221
2222
2223
2224
2225
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 2218

class VoiceParameters < Struct.new(
  :inline_template_body,
  :language_code,
  :voice_id,
  :voice_message_body_text_type)
  SENSITIVE = [:inline_template_body]
  include Aws::Structure
end