« blib/lib/Paws/Pinpoint/VoiceChannelResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/VoiceTemplateRequest.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::VoiceMessage; | ||
| 3 | use Moose; | ||
| 4 | has Body => (is => 'ro', isa => 'Str'); | ||
| 5 | has LanguageCode => (is => 'ro', isa => 'Str'); | ||
| 6 | has OriginationNumber => (is => 'ro', isa => 'Str'); | ||
| 7 | has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string'); | ||
| 8 | has VoiceId => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Pinpoint::VoiceMessage | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Pinpoint::VoiceMessage object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Body => $value, ..., VoiceId => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::VoiceMessage object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Body | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies the settings for a one-time voice message that's sent | ||
| 41 | directly to an endpoint through the voice channel. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Body => Str | ||
| 47 | |||
| 48 | The text of the script to use for the voice message. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 LanguageCode => Str | ||
| 52 | |||
| 53 | The code for the language to use when synthesizing the text of the | ||
| 54 | message script. For a list of supported languages and the code for each | ||
| 55 | one, see the Amazon Polly Developer Guide | ||
| 56 | (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). | ||
| 57 | |||
| 58 | |||
| 59 | =head2 OriginationNumber => Str | ||
| 60 | |||
| 61 | The long code to send the voice message from. This value should be one | ||
| 62 | of the dedicated long codes that's assigned to your AWS account. | ||
| 63 | Although it isn't required, we recommend that you specify the long code | ||
| 64 | in E.164 format, for example +12065550100, to ensure prompt and | ||
| 65 | accurate delivery of the message. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string> | ||
| 69 | |||
| 70 | The default message variables to use in the voice message. You can | ||
| 71 | override the default variables with individual address variables. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 VoiceId => Str | ||
| 75 | |||
| 76 | The name of the voice to use when delivering the message. For a list of | ||
| 77 | supported voices, see the Amazon Polly Developer Guide | ||
| 78 | (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |