Interface CfnCampaign.ICampaignSmsMessageProperty
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.AWS.Pinpoint.dll
Syntax (csharp)
public interface ICampaignSmsMessageProperty
Syntax (vb)
Public Interface ICampaignSmsMessageProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;
var campaignSmsMessageProperty = new CampaignSmsMessageProperty {
Body = "body",
EntityId = "entityId",
MessageType = "messageType",
OriginationNumber = "originationNumber",
SenderId = "senderId",
TemplateId = "templateId"
};
Synopsis
Properties
Body | The body of the SMS message. |
EntityId | The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country. |
MessageType | The SMS message type. |
OriginationNumber | The long code to send the SMS message from. |
SenderId | The alphabetic Sender ID to display as the sender of the message on a recipient's device. |
TemplateId | The template ID received from the regulatory body for sending SMS in your country. |
Properties
Body
The body of the SMS message.
virtual string Body { get; }
Property Value
System.String
Remarks
EntityId
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
virtual string EntityId { get; }
Property Value
System.String
Remarks
MessageType
The SMS message type.
virtual string MessageType { get; }
Property Value
System.String
Remarks
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
The long code to send the SMS message from.
virtual string OriginationNumber { get; }
Property Value
System.String
Remarks
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.
SenderId
The alphabetic Sender ID to display as the sender of the message on a recipient's device.
virtual string SenderId { get; }
Property Value
System.String
Remarks
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 .
TemplateId
The template ID received from the regulatory body for sending SMS in your country.
virtual string TemplateId { get; }
Property Value
System.String