software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.CampaignSmsMessageProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.CampaignSmsMessageProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(value=Stable)
public static interface CfnCampaign.CampaignSmsMessageProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CampaignSmsMessageProperty campaignSmsMessageProperty = CampaignSmsMessageProperty.builder()
         .body("body")
         .entityId("entityId")
         .messageType("messageType")
         .originationNumber("originationNumber")
         .senderId("senderId")
         .templateId("templateId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCampaign.CampaignSmsMessageProperty.Builder A builder for CfnCampaign.CampaignSmsMessageProperty
static class	CfnCampaign.CampaignSmsMessageProperty.Jsii$Proxy An implementation for CfnCampaign.CampaignSmsMessageProperty

Method Summary

Modifier and Type	Method and Description
static CfnCampaign.CampaignSmsMessageProperty.Builder	builder()
default String	getBody() The body of the SMS message.
default String	getEntityId() The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
default String	getMessageType() The SMS message type.
default String	getOriginationNumber() The long code to send the SMS message from.
default String	getSenderId() The alphabetic Sender ID to display as the sender of the message on a recipient's device.
default String	getTemplateId() The template ID received from the regulatory body for sending SMS in your country.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBody

@Stability(value=Stable)
 @Nullable
default String getBody()

The body of the SMS message.

getEntityId

@Stability(value=Stable)
 @Nullable
default String getEntityId()

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

getMessageType

@Stability(value=Stable)
 @Nullable
default String getMessageType()

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

getOriginationNumber

@Stability(value=Stable)
 @Nullable
default String getOriginationNumber()

The long code to send the SMS message from.

This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

getSenderId

@Stability(value=Stable)
 @Nullable
default String getSenderId()

The alphabetic Sender ID to display as the sender of the message on a recipient's device.

Support for sender IDs varies by country or region. To specify a phone number as the sender, omit this parameter and use OriginationNumber instead. For more information about support for Sender ID by country, see the Amazon Pinpoint User Guide .

getTemplateId

@Stability(value=Stable)
 @Nullable
default String getTemplateId()

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

builder

@Stability(value=Stable)
static CfnCampaign.CampaignSmsMessageProperty.Builder builder()

Returns:

a CfnCampaign.CampaignSmsMessageProperty.Builder of CfnCampaign.CampaignSmsMessageProperty