pinpointsmsvoicev2_send_voice_message: Allows you to send a request that sends a text message...
In paws.customer.engagement: 'Amazon Web Services' Customer Engagement Services

View source: R/pinpointsmsvoicev2_operations.R

pinpointsmsvoicev2_send_voice_message

R Documentation

Allows you to send a request that sends a text message through Amazon Pinpoint

Description

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

See https://www.paws-r-sdk.com/docs/pinpointsmsvoicev2_send_voice_message/ for full documentation.

Usage

pinpointsmsvoicev2_send_voice_message(
  DestinationPhoneNumber,
  OriginationIdentity,
  MessageBody = NULL,
  MessageBodyTextType = NULL,
  VoiceId = NULL,
  ConfigurationSetName = NULL,
  MaxPricePerMinute = NULL,
  TimeToLive = NULL,
  Context = NULL,
  DryRun = NULL
)

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.
`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.