Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint-sms-voice ]

send-voice-message

Description

Create a new voice message and send it to a recipient's phone number.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-voice-message
[--caller-id <value>]
[--configuration-set-name <value>]
[--content <value>]
[--destination-phone-number <value>]
[--origination-phone-number <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--caller-id (string) The phone number that appears on recipients' devices when they receive the message.

--configuration-set-name (string) The name of the configuration set that you want to use to send the message.

--content (structure) An object that contains a voice message and information about the recipient that you want to send it to.

Shorthand Syntax:

CallInstructionsMessage={Text=string},PlainTextMessage={LanguageCode=string,Text=string,VoiceId=string},SSMLMessage={LanguageCode=string,Text=string,VoiceId=string}

JSON Syntax:

{
  "CallInstructionsMessage": {
    "Text": "string"
  },
  "PlainTextMessage": {
    "LanguageCode": "string",
    "Text": "string",
    "VoiceId": "string"
  },
  "SSMLMessage": {
    "LanguageCode": "string",
    "Text": "string",
    "VoiceId": "string"
  }
}

--destination-phone-number (string) The phone number that you want to send the voice message to.

--origination-phone-number (string) The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request.

--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)

A unique identifier for the voice message.