pinpoint/aws.sdk.kotlin.services.pinpoint.model/SmsMessage

SmsMessage

class SmsMessage

Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

Types

object Companion

Properties

val body: String?

The body of the SMS message.

val entityId: String?

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

val keyword: String?

The SMS program name that you provided to AWS Support when you requested your dedicated number.

val mediaUrl: String?

This field is reserved for future use.

val messageType: MessageType?

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

originationNumber

val originationNumber: String?

The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

val senderId: String?

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

val substitutions: Map<String, List<String>>?

The message variables to use in the SMS message. You can override the default variables with individual address variables.

val templateId: String?

The template ID received from the regulatory body for sending SMS in your country.

Functions

inline fun copy(block: SmsMessage.Builder.() -> Unit = {}): SmsMessage

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String