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

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

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

Overview

Note:

When making an API call, you may pass SendVoiceMessageRequest data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#caller_idString

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

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 590

class SendVoiceMessageRequest < Struct.new(
  :caller_id,
  :configuration_set_name,
  :content,
  :destination_phone_number,
  :origination_phone_number)
  include Aws::Structure
end

#configuration_set_nameString

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

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 590

class SendVoiceMessageRequest < Struct.new(
  :caller_id,
  :configuration_set_name,
  :content,
  :destination_phone_number,
  :origination_phone_number)
  include Aws::Structure
end

#contentTypes::VoiceMessageContent

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



590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 590

class SendVoiceMessageRequest < Struct.new(
  :caller_id,
  :configuration_set_name,
  :content,
  :destination_phone_number,
  :origination_phone_number)
  include Aws::Structure
end

#destination_phone_numberString

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

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 590

class SendVoiceMessageRequest < Struct.new(
  :caller_id,
  :configuration_set_name,
  :content,
  :destination_phone_number,
  :origination_phone_number)
  include Aws::Structure
end

#origination_phone_numberString

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)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 590

class SendVoiceMessageRequest < Struct.new(
  :caller_id,
  :configuration_set_name,
  :content,
  :destination_phone_number,
  :origination_phone_number)
  include Aws::Structure
end