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

Amazonka.Pinpoint.Types.VoiceMessage

Description

Synopsis

data VoiceMessage = VoiceMessage' {
- substitutions :: Maybe (HashMap Text [Text])
- languageCode :: Maybe Text
- originationNumber :: Maybe Text
- body :: Maybe Text
- voiceId :: Maybe Text
}
newVoiceMessage :: VoiceMessage
voiceMessage_substitutions :: Lens' VoiceMessage (Maybe (HashMap Text [Text]))
voiceMessage_languageCode :: Lens' VoiceMessage (Maybe Text)
voiceMessage_originationNumber :: Lens' VoiceMessage (Maybe Text)
voiceMessage_body :: Lens' VoiceMessage (Maybe Text)
voiceMessage_voiceId :: Lens' VoiceMessage (Maybe Text)

Documentation

data VoiceMessage Source #

Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

See: newVoiceMessage smart constructor.

Constructors

VoiceMessage'

Fields

substitutions :: Maybe (HashMap Text [Text])
The default message variables to use in the voice message. You can override the default variables with individual address variables.
languageCode :: Maybe Text
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
originationNumber :: Maybe Text
The long code to send the voice 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 in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
body :: Maybe Text
The text of the script to use for the voice message.
voiceId :: Maybe Text
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

Instances

Instances details

Eq VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage Methods (==) :: VoiceMessage -> VoiceMessage -> Bool # (/=) :: VoiceMessage -> VoiceMessage -> Bool #
Read VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage Methods readsPrec :: Int -> ReadS VoiceMessage # readList :: ReadS [VoiceMessage] # readPrec :: ReadPrec VoiceMessage # readListPrec :: ReadPrec [VoiceMessage] #
Show VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage Methods showsPrec :: Int -> VoiceMessage -> ShowS # show :: VoiceMessage -> String # showList :: [VoiceMessage] -> ShowS #
Generic VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage Associated Types type Rep VoiceMessage :: Type -> Type # Methods from :: VoiceMessage -> Rep VoiceMessage x # to :: Rep VoiceMessage x -> VoiceMessage #
NFData VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage Methods rnf :: VoiceMessage -> () #
Hashable VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage Methods hashWithSalt :: Int -> VoiceMessage -> Int # hash :: VoiceMessage -> Int #
ToJSON VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage Methods toJSON :: VoiceMessage -> Value # toEncoding :: VoiceMessage -> Encoding # toJSONList :: [VoiceMessage] -> Value # toEncodingList :: [VoiceMessage] -> Encoding #
type Rep VoiceMessage Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceMessage type Rep VoiceMessage = D1 ('MetaData "VoiceMessage" "Amazonka.Pinpoint.Types.VoiceMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "VoiceMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "originationNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newVoiceMessage :: VoiceMessage Source #

Create a value of VoiceMessage 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:substitutions:VoiceMessage', voiceMessage_substitutions - The default message variables to use in the voice message. You can override the default variables with individual address variables.

$sel:languageCode:VoiceMessage', voiceMessage_languageCode - The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

$sel:originationNumber:VoiceMessage', voiceMessage_originationNumber - The long code to send the voice 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 in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

$sel:body:VoiceMessage', voiceMessage_body - The text of the script to use for the voice message.

$sel:voiceId:VoiceMessage', voiceMessage_voiceId - The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

voiceMessage_substitutions :: Lens' VoiceMessage (Maybe (HashMap Text [Text])) Source #

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

voiceMessage_languageCode :: Lens' VoiceMessage (Maybe Text) Source #

The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

voiceMessage_originationNumber :: Lens' VoiceMessage (Maybe Text) Source #

The long code to send the voice 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 in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

voiceMessage_body :: Lens' VoiceMessage (Maybe Text) Source #

The text of the script to use for the voice message.

voiceMessage_voiceId :: Lens' VoiceMessage (Maybe Text) Source #

The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.