Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SmsVoice.SendVoiceMessage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create a new voice message and send it to a recipient's phone number.

Synopsis

data SendVoiceMessage = SendVoiceMessage' {
- callerId :: Maybe Text
- configurationSetName :: Maybe Text
- content :: Maybe VoiceMessageContent
- destinationPhoneNumber :: Maybe Text
- originationPhoneNumber :: Maybe Text
}
newSendVoiceMessage :: SendVoiceMessage
sendVoiceMessage_callerId :: Lens' SendVoiceMessage (Maybe Text)
sendVoiceMessage_configurationSetName :: Lens' SendVoiceMessage (Maybe Text)
sendVoiceMessage_content :: Lens' SendVoiceMessage (Maybe VoiceMessageContent)
sendVoiceMessage_destinationPhoneNumber :: Lens' SendVoiceMessage (Maybe Text)
sendVoiceMessage_originationPhoneNumber :: Lens' SendVoiceMessage (Maybe Text)
data SendVoiceMessageResponse = SendVoiceMessageResponse' {
- messageId :: Maybe Text
- httpStatus :: Int
}
newSendVoiceMessageResponse :: Int -> SendVoiceMessageResponse
sendVoiceMessageResponse_messageId :: Lens' SendVoiceMessageResponse (Maybe Text)
sendVoiceMessageResponse_httpStatus :: Lens' SendVoiceMessageResponse Int

Creating a Request

data SendVoiceMessage Source #

SendVoiceMessageRequest

See: newSendVoiceMessage smart constructor.

Constructors

SendVoiceMessage'

Fields

callerId :: Maybe Text
The phone number that appears on recipients' devices when they receive the message.
configurationSetName :: Maybe Text
The name of the configuration set that you want to use to send the message.
content :: Maybe VoiceMessageContent
destinationPhoneNumber :: Maybe Text
The phone number that you want to send the voice message to.
originationPhoneNumber :: Maybe Text
The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request.

Instances

Instances details

ToJSON SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods toJSON :: SendVoiceMessage -> Value # toEncoding :: SendVoiceMessage -> Encoding # toJSONList :: [SendVoiceMessage] -> Value # toEncodingList :: [SendVoiceMessage] -> Encoding #
ToHeaders SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods toHeaders :: SendVoiceMessage -> [Header] #
ToPath SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods toPath :: SendVoiceMessage -> ByteString #
ToQuery SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods toQuery :: SendVoiceMessage -> QueryString #
AWSRequest SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Associated Types type AWSResponse SendVoiceMessage # Methods request :: (Service -> Service) -> SendVoiceMessage -> Request SendVoiceMessage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendVoiceMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendVoiceMessage))) #
Generic SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Associated Types type Rep SendVoiceMessage :: Type -> Type # Methods from :: SendVoiceMessage -> Rep SendVoiceMessage x # to :: Rep SendVoiceMessage x -> SendVoiceMessage #
Read SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods readsPrec :: Int -> ReadS SendVoiceMessage # readList :: ReadS [SendVoiceMessage] # readPrec :: ReadPrec SendVoiceMessage # readListPrec :: ReadPrec [SendVoiceMessage] #
Show SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods showsPrec :: Int -> SendVoiceMessage -> ShowS # show :: SendVoiceMessage -> String # showList :: [SendVoiceMessage] -> ShowS #
NFData SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods rnf :: SendVoiceMessage -> () #
Eq SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods (==) :: SendVoiceMessage -> SendVoiceMessage -> Bool # (/=) :: SendVoiceMessage -> SendVoiceMessage -> Bool #
Hashable SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods hashWithSalt :: Int -> SendVoiceMessage -> Int # hash :: SendVoiceMessage -> Int #
type AWSResponse SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage type AWSResponse SendVoiceMessage = SendVoiceMessageResponse
type Rep SendVoiceMessage Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage type Rep SendVoiceMessage = D1 ('MetaData "SendVoiceMessage" "Amazonka.SmsVoice.SendVoiceMessage" "amazonka-sms-voice-2.0-3p97esUzflC4CxQYj8cHEb" 'False) (C1 ('MetaCons "SendVoiceMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceMessageContent)) :: (S1 ('MetaSel ('Just "destinationPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "originationPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newSendVoiceMessage :: SendVoiceMessage Source #

Create a value of SendVoiceMessage 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:callerId:SendVoiceMessage', sendVoiceMessage_callerId - The phone number that appears on recipients' devices when they receive the message.

$sel:configurationSetName:SendVoiceMessage', sendVoiceMessage_configurationSetName - The name of the configuration set that you want to use to send the message.

$sel:content:SendVoiceMessage', sendVoiceMessage_content - Undocumented member.

$sel:destinationPhoneNumber:SendVoiceMessage', sendVoiceMessage_destinationPhoneNumber - The phone number that you want to send the voice message to.

$sel:originationPhoneNumber:SendVoiceMessage', sendVoiceMessage_originationPhoneNumber - The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request.

Request Lenses

sendVoiceMessage_callerId :: Lens' SendVoiceMessage (Maybe Text) Source #

The phone number that appears on recipients' devices when they receive the message.

sendVoiceMessage_configurationSetName :: Lens' SendVoiceMessage (Maybe Text) Source #

The name of the configuration set that you want to use to send the message.

sendVoiceMessage_content :: Lens' SendVoiceMessage (Maybe VoiceMessageContent) Source #

Undocumented member.

sendVoiceMessage_destinationPhoneNumber :: Lens' SendVoiceMessage (Maybe Text) Source #

The phone number that you want to send the voice message to.

sendVoiceMessage_originationPhoneNumber :: Lens' SendVoiceMessage (Maybe Text) Source #

The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request.

Destructuring the Response

data SendVoiceMessageResponse Source #

An object that that contains the Message ID of a Voice message that was sent successfully.

See: newSendVoiceMessageResponse smart constructor.

Constructors

SendVoiceMessageResponse'
Fields messageId :: Maybe Text A unique identifier for the voice message. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Associated Types type Rep SendVoiceMessageResponse :: Type -> Type # Methods from :: SendVoiceMessageResponse -> Rep SendVoiceMessageResponse x # to :: Rep SendVoiceMessageResponse x -> SendVoiceMessageResponse #
Read SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods readsPrec :: Int -> ReadS SendVoiceMessageResponse # readList :: ReadS [SendVoiceMessageResponse] # readPrec :: ReadPrec SendVoiceMessageResponse # readListPrec :: ReadPrec [SendVoiceMessageResponse] #
Show SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods showsPrec :: Int -> SendVoiceMessageResponse -> ShowS # show :: SendVoiceMessageResponse -> String # showList :: [SendVoiceMessageResponse] -> ShowS #
NFData SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods rnf :: SendVoiceMessageResponse -> () #
Eq SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage Methods (==) :: SendVoiceMessageResponse -> SendVoiceMessageResponse -> Bool # (/=) :: SendVoiceMessageResponse -> SendVoiceMessageResponse -> Bool #
type Rep SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.SmsVoice.SendVoiceMessage type Rep SendVoiceMessageResponse = D1 ('MetaData "SendVoiceMessageResponse" "Amazonka.SmsVoice.SendVoiceMessage" "amazonka-sms-voice-2.0-3p97esUzflC4CxQYj8cHEb" 'False) (C1 ('MetaCons "SendVoiceMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendVoiceMessageResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendVoiceMessageResponse'`
-> SendVoiceMessageResponse

Create a value of SendVoiceMessageResponse 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:messageId:SendVoiceMessageResponse', sendVoiceMessageResponse_messageId - A unique identifier for the voice message.

$sel:httpStatus:SendVoiceMessageResponse', sendVoiceMessageResponse_httpStatus - The response's http status code.

Response Lenses

sendVoiceMessageResponse_messageId :: Lens' SendVoiceMessageResponse (Maybe Text) Source #

A unique identifier for the voice message.

sendVoiceMessageResponse_httpStatus :: Lens' SendVoiceMessageResponse Int Source #

The response's http status code.