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 ]
send-voice-message¶
Description¶
Create a new voice message and send it to a recipient's phone number.
See also: AWS API Documentation
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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.CallInstructionsMessage -> (structure)
An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup.
Text -> (string)
The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.PlainTextMessage -> (structure)
An object that defines a message that contains unformatted text.
LanguageCode -> (string)
The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.Text -> (string)
The plain (not SSML-formatted) text to deliver to the recipient.VoiceId -> (string)
The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide.SSMLMessage -> (structure)
An object that defines a message that contains SSML-formatted text.
LanguageCode -> (string)
The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.Text -> (string)
The SSML-formatted text to deliver to the recipient.VoiceId -> (string)
The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide.
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.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.