Class: Aws::Pinpoint::Types::VoiceMessage

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::VoiceMessage

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Specifies the settings for a one-time voice message that’s sent directly to an endpoint through the voice channel.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  The text of the script to use for the voice message.

• #language_code ⇒ String

  The code for the language to use when synthesizing the text of the message script.

• #origination_number ⇒ String

  The long code to send the voice message from.

• #substitutions ⇒ Hash<String,Array<String>>

  The default message variables to use in the voice message.

• #voice_id ⇒ String

  The name of the voice to use when delivering the message.

Instance Attribute Details

#body ⇒ String

The text of the script to use for the voice message.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13383

class VoiceMessage < Struct.new(
  :body,
  :language_code,
  :origination_number,
  :substitutions,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the [Amazon Polly Developer Guide].

[1]: docs.aws.amazon.com/polly/latest/dg/what-is.html

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13383

class VoiceMessage < Struct.new(
  :body,
  :language_code,
  :origination_number,
  :substitutions,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#origination_number ⇒ String

The long code to send the voice message from. This value should be one of the dedicated long codes that’s assigned to your AWS account. Although it isn’t required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13383

class VoiceMessage < Struct.new(
  :body,
  :language_code,
  :origination_number,
  :substitutions,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#substitutions ⇒ Hash<String,Array<String>>

The default message variables to use in the voice message. You can override the default variables with individual address variables.

Returns:

• (Hash<String,Array<String>>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13383

class VoiceMessage < Struct.new(
  :body,
  :language_code,
  :origination_number,
  :substitutions,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#voice_id ⇒ String

The name of the voice to use when delivering the message. For a list of supported voices, see the [Amazon Polly Developer Guide].

[1]: docs.aws.amazon.com/polly/latest/dg/what-is.html

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13383

class VoiceMessage < Struct.new(
  :body,
  :language_code,
  :origination_number,
  :substitutions,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end