PinpointSMSVoiceV2 / Client / send_voice_message

send_voice_message#

PinpointSMSVoiceV2.Client.send_voice_message(**kwargs)#

Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.

See also: AWS API Documentation

Request Syntax

response = client.send_voice_message(
    DestinationPhoneNumber='string',
    OriginationIdentity='string',
    MessageBody='string',
    MessageBodyTextType='TEXT'|'SSML',
    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',
    ConfigurationSetName='string',
    MaxPricePerMinute='string',
    TimeToLive=123,
    Context={
        'string': 'string'
    },
    DryRun=True|False,
    ProtectConfigurationId='string',
    MessageFeedbackEnabled=True|False
)
Parameters:

  • DestinationPhoneNumber (string) –

    [REQUIRED]

    The destination phone number in E.164 format.

  • OriginationIdentity (string) –

    [REQUIRED]

    The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

    Warning

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

  • MessageBody (string) – The text to convert to a voice message.

  • MessageBodyTextType (string) –

    Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

    • TEXT: This is the default value. When used the maximum character limit is 3000.

    • SSML: When used the maximum character limit is 6000 including SSML tagging.

  • VoiceId (string) – The voice for the Amazon Polly service to use. By default this is set to “MATTHEW”.

  • ConfigurationSetName (string) – The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

  • MaxPricePerMinute (string) – The maximum amount to spend per voice message, in US dollars.

  • TimeToLive (integer) – How long the voice message is valid for. By default this is 72 hours.

  • Context (dict) –

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

    • (string) –

      • (string) –

  • DryRun (boolean) – When set to true, the message is checked and validated, but isn’t sent to the end recipient.

  • ProtectConfigurationId (string) – The unique identifier for the protect configuration.

  • MessageFeedbackEnabled (boolean) – Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

Return type:

dict

Returns:

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) –

    • MessageId (string) –

      The unique identifier for the message.

Exceptions