Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint-sms-voice-v2 ]

send-voice-message

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 also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-voice-message
--destination-phone-number <value>
--origination-identity <value>
[--message-body <value>]
[--message-body-text-type <value>]
[--voice-id <value>]
[--configuration-set-name <value>]
[--max-price-per-minute <value>]
[--time-to-live <value>]
[--context <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--destination-phone-number (string)

The destination phone number in E.164 format.

--origination-identity (string)

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

--message-body (string)

The text to convert to a voice message.

--message-body-text-type (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.

Possible values:

  • TEXT
  • SSML

--voice-id (string)

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

Possible values:

  • 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

--configuration-set-name (string)

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

--max-price-per-minute (string)

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

--time-to-live (integer)

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

--context (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--dry-run | --no-dry-run (boolean)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

MessageId -> (string)

The unique identifier for the message.