[ aws . pinpoint-sms-voice-v2 ]
send-text-message¶
Description¶
Creates a new text message and sends it to a recipient’s phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
send-text-message
--destination-phone-number <value>
[--origination-identity <value>]
[--message-body <value>]
[--message-type <value>]
[--keyword <value>]
[--configuration-set-name <value>]
[--max-price <value>]
[--time-to-live <value>]
[--context <value>]
[--destination-country-parameters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--destination-phone-number (string)
The destination phone number in E.164 format.
--origination-identity (string)
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
--message-body (string)
The body of the text message.
--message-type (string)
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.
Possible values:
TRANSACTIONAL
PROMOTIONAL
--keyword (string)
When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
--configuration-set-name (string)
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
--max-price (string)
The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
--time-to-live (integer)
How long the text 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"
...}
--destination-country-parameters (map)
This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India .
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
Where valid key names are:
IN_TEMPLATE_ID
IN_ENTITY_ID
JSON Syntax:
{"IN_TEMPLATE_ID"|"IN_ENTITY_ID": "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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.