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

Class: Aws::PinpointSMSVoice::Types::SendVoiceMessageRequest

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

Overview

Note:

When passing SendVoiceMessageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  caller_id: "String",
  configuration_set_name: "WordCharactersWithDelimiters",
  content: {
    call_instructions_message: {
      text: "NonEmptyString",
    },
    plain_text_message: {
      language_code: "String",
      text: "NonEmptyString",
      voice_id: "String",
    },
    ssml_message: {
      language_code: "String",
      text: "NonEmptyString",
      voice_id: "String",
    },
  },
  destination_phone_number: "NonEmptyString",
  origination_phone_number: "NonEmptyString",
}

A request to create and send a new voice message.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#caller_id ⇒ String

The phone number that appears on recipients\' devices when they receive the message.

Returns:

  • (String) —

    The phone number that appears on recipients\' devices when they receive the message.

#configuration_set_name ⇒ String

The name of the configuration set that you want to use to send the message.

Returns:

  • (String) —

    The name of the configuration set that you want to use to send the message.

#content ⇒ Types::VoiceMessageContent

An object that contains a voice message and information about the recipient that you want to send it to.

Returns:

  • (Types::VoiceMessageContent) —

    An object that contains a voice message and information about the recipient that you want to send it to.

#destination_phone_number ⇒ String

The phone number that you want to send the voice message to.

Returns:

  • (String) —

    The phone number that you want to send the voice message to.

#origination_phone_number ⇒ String

The phone number that Amazon Pinpoint should use to send the voice message. This isn\'t necessarily the phone number that appears on recipients\' devices when they receive the message, because you can specify a CallerId parameter in the request.

Returns:

  • (String) —

    The phone number that Amazon Pinpoint should use to send the voice message.