pinpointsmsvoicev2_send_text_message: Creates a new text message and sends it to a recipient's...

View source: R/pinpointsmsvoicev2_operations.R

pinpointsmsvoicev2_send_text_messageR Documentation

Creates a new text message and sends it to a recipient's phone number

Description

Creates a new text message and sends it to a recipient's phone number.

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

Usage

pinpointsmsvoicev2_send_text_message(
  DestinationPhoneNumber,
  OriginationIdentity = NULL,
  MessageBody = NULL,
  MessageType = NULL,
  Keyword = NULL,
  ConfigurationSetName = NULL,
  MaxPrice = NULL,
  TimeToLive = NULL,
  Context = NULL,
  DestinationCountryParameters = NULL,
  DryRun = NULL
)

Arguments

DestinationPhoneNumber

[required] The destination phone number in E.164 format.

OriginationIdentity

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

MessageBody

The body of the text message.

MessageType

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.

Keyword

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.

ConfigurationSetName

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

MaxPrice

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

TimeToLive

How long the text 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.

DestinationCountryParameters

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.

DryRun

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


paws.customer.engagement documentation built on Sept. 12, 2023, 1:19 a.m.