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

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

Overview

Note:

When making an API call, you may pass VoiceMessage data as a hash:

{
  body: "__string",
  language_code: "__string",
  origination_number: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  voice_id: "__string",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

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

Returns:

  • (String)


20233
20234
20235
20236
20237
20238
20239
20240
20241
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20233

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

#language_codeString

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.

Returns:

  • (String)


20233
20234
20235
20236
20237
20238
20239
20240
20241
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20233

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

#origination_numberString

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)


20233
20234
20235
20236
20237
20238
20239
20240
20241
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20233

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

#substitutionsHash<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>>)


20233
20234
20235
20236
20237
20238
20239
20240
20241
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20233

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

#voice_idString

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

Returns:

  • (String)


20233
20234
20235
20236
20237
20238
20239
20240
20241
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20233

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