Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- data JourneySMSMessage = JourneySMSMessage' {}
- newJourneySMSMessage :: JourneySMSMessage
- journeySMSMessage_originationNumber :: Lens' JourneySMSMessage (Maybe Text)
- journeySMSMessage_templateId :: Lens' JourneySMSMessage (Maybe Text)
- journeySMSMessage_messageType :: Lens' JourneySMSMessage (Maybe MessageType)
- journeySMSMessage_senderId :: Lens' JourneySMSMessage (Maybe Text)
- journeySMSMessage_entityId :: Lens' JourneySMSMessage (Maybe Text)
Documentation
data JourneySMSMessage Source #
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
See: newJourneySMSMessage
smart constructor.
JourneySMSMessage' | |
|
Instances
newJourneySMSMessage :: JourneySMSMessage Source #
Create a value of JourneySMSMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:originationNumber:JourneySMSMessage'
, journeySMSMessage_originationNumber
- 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.
$sel:templateId:JourneySMSMessage'
, journeySMSMessage_templateId
- The template ID received from the regulatory body for sending SMS in
your country.
$sel:messageType:JourneySMSMessage'
, journeySMSMessage_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).
$sel:senderId:JourneySMSMessage'
, journeySMSMessage_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. For more
information, see
Supported Countries and Regions
in the Amazon Pinpoint User Guide.
$sel:entityId:JourneySMSMessage'
, journeySMSMessage_entityId
- The entity ID or Principal Entity (PE) id received from the regulatory
body for sending SMS in your country.
journeySMSMessage_originationNumber :: Lens' JourneySMSMessage (Maybe Text) Source #
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.
journeySMSMessage_templateId :: Lens' JourneySMSMessage (Maybe Text) Source #
The template ID received from the regulatory body for sending SMS in your country.
journeySMSMessage_messageType :: Lens' JourneySMSMessage (Maybe MessageType) Source #
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).
journeySMSMessage_senderId :: Lens' JourneySMSMessage (Maybe Text) Source #
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
journeySMSMessage_entityId :: Lens' JourneySMSMessage (Maybe Text) Source #
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.