Interface SMSMessage.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SMSMessage.Builder,
,SMSMessage> SdkBuilder<SMSMessage.Builder,
,SMSMessage> SdkPojo
- Enclosing class:
SMSMessage
-
Method Summary
Modifier and TypeMethodDescriptionThe body of the SMS message.The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.The SMS program name that you provided to AWS Support when you requested your dedicated number.This field is reserved for future use.messageType
(String messageType) The SMS message type.messageType
(MessageType messageType) The SMS message type.originationNumber
(String originationNumber) The number to send the SMS message from.The sender ID to display as the sender of the message on a recipient's device.substitutions
(Map<String, ? extends Collection<String>> substitutions) The message variables to use in the SMS message.templateId
(String templateId) The template ID received from the regulatory body for sending SMS in your country.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
body
The body of the SMS message.
- Parameters:
body
- The body of the SMS message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyword
The SMS program name that you provided to AWS Support when you requested your dedicated number.
- Parameters:
keyword
- The SMS program name that you provided to AWS Support when you requested your dedicated number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaUrl
This field is reserved for future use.
- Parameters:
mediaUrl
- This field is reserved for future use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).
- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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).
- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
originationNumber
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.
- Parameters:
originationNumber
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
senderId
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.
- Parameters:
senderId
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
substitutions
The message variables to use in the SMS message. You can override the default variables with individual address variables.
- Parameters:
substitutions
- The message variables to use in the SMS message. You can override the default variables with individual address variables.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
entityId
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
- Parameters:
entityId
- The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateId
The template ID received from the regulatory body for sending SMS in your country.
- Parameters:
templateId
- The template ID received from the regulatory body for sending SMS in your country.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-