Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Allows you to send a request that sends a voice message. This operation uses <a href="http://aws.amazon.com/polly/">Amazon Polly</a> to convert a text script into a voice message.

post/#X-Amz-Target=PinpointSMSVoiceV2.SendVoiceMessage

Headers

X-Amz-Target'PinpointSMSVoiceV2.SendVoiceMessage' required

Request body

DestinationPhoneNumberstring required

The destination phone number in E.164 format.

OriginationIdentitystring required
<p>The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
MessageBodystring

The text to convert to a voice message.

MessageBodyTextType'TEXT' | 'SSML'
<p>Specifies if the MessageBody field contains text or <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">speech synthesis markup language (SSML)</a>.</p> <ul> <li> <p>TEXT: This is the default value. When used the maximum character limit is 3000.</p> </li> <li> <p>SSML: When used the maximum character limit is 6000 including SSML tagging.</p> </li> </ul>
VoiceId'AMY' | 'ASTRID' | 'BIANCA' | 'BRIAN' | 'CAMILA' | 'CARLA' | 'CARMEN' | 'CELINE' | 'CHANTAL' | 'CONCHITA' | 'CRISTIANO' | 'DORA' | 'EMMA' | 'ENRIQUE' | 'EWA' | 'FILIZ' | 'GERAINT' | 'GIORGIO' | 'GWYNETH' | 'HANS' | 'INES' | 'IVY' | 'JACEK' | 'JAN' | 'JOANNA' | 'JOEY' | 'JUSTIN' | 'KARL' | 'KENDRA' | 'KIMBERLY' | 'LEA' | 'LIV' | 'LOTTE' | 'LUCIA' | 'LUPE' | 'MADS' | 'MAJA' | 'MARLENE' | 'MATHIEU' | 'MATTHEW' | 'MAXIM' | 'MIA' | 'MIGUEL' | 'MIZUKI' | 'NAJA' | 'NICOLE' | 'PENELOPE' | 'RAVEENA' | 'RICARDO' | 'RUBEN' | 'RUSSELL' | 'SALLI' | 'SEOYEON' | 'TAKUMI' | 'TATYANA' | 'VICKI' | 'VITORIA' | 'ZEINA' | 'ZHIYU'

The voice for the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly</a> service to use. By default this is set to "MATTHEW".

ConfigurationSetNamestring

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

MaxPricePerMinutestring

The maximum amount to spend per voice message, in US dollars.

TimeToLiveinteger

How long the voice message is valid for. By default this is 72 hours.

Contextobject

You can specify custom data in this field. If you do, that data is logged to the event destination.

DryRunboolean

When set to true, the message is checked and validated, but isn't sent to the end recipient.

ProtectConfigurationIdstring

The unique identifier for the protect configuration.

MessageFeedbackEnabledboolean

Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <a>PutMessageFeedback</a>.

Response

Success

MessageIdstring

The unique identifier for the message.