pinpointsmsvoicev2/aws.sdk.kotlin.services.pinpointsmsvoicev2.model/SendTextMessageRequest/Builder

Builder

class Builder

Properties

configurationSetName

var configurationSetName: String?

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

context

var context: Map<String, String>?

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

destinationCountryParameters

var destinationCountryParameters: Map<DestinationCountryParameterKey, String>?

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.

destinationPhoneNumber

var destinationPhoneNumber: String?

The destination phone number in E.164 format.

dryRun

var dryRun: Boolean?

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

keyword

var 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.

maxPrice

var maxPrice: String?

The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

messageBody

var messageBody: String?

The body of the text message.

messageFeedbackEnabled

var messageFeedbackEnabled: Boolean?

Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

messageType

var messageType: MessageType?

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

originationIdentity

var originationIdentity: String?

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

protectConfigurationId

var protectConfigurationId: String?

The unique identifier for the protect configuration.

timeToLive

var timeToLive: Int?

How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.