AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing VoiceMessage as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

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

Returns:

  • (String)

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

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

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

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

    The long code to send the voice message from.

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

    The default message variables to use in the voice message.

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

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