Skip to content

Allows you to send a request that sends a voice message

Description

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.

Usage

pinpointsmsvoicev2_send_voice_message(DestinationPhoneNumber,
  OriginationIdentity, MessageBody, MessageBodyTextType, VoiceId,
  ConfigurationSetName, MaxPricePerMinute, TimeToLive, Context, DryRun,
  ProtectConfigurationId, MessageFeedbackEnabled)

Arguments

  • DestinationPhoneNumber

    [required] The destination phone number in E.164 format.

  • OriginationIdentity

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

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

  • MessageBody

    The text to convert to a voice message.

  • MessageBodyTextType

    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

    The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

  • ConfigurationSetName

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

  • MaxPricePerMinute

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

  • TimeToLive

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

  • Context

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

  • DryRun

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

  • ProtectConfigurationId

    The unique identifier for the protect configuration.

  • MessageFeedbackEnabled

    Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using put_message_feedback.

Value

A list with the following syntax:

list(
  MessageId = "string"
)

Request syntax

svc$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 = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  ProtectConfigurationId = "string",
  MessageFeedbackEnabled = TRUE|FALSE
)