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.Chime.CreateMeetingDialOut

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

Synopsis

data CreateMeetingDialOut = CreateMeetingDialOut' {
- meetingId :: Text
- fromPhoneNumber :: Sensitive Text
- toPhoneNumber :: Sensitive Text
- joinToken :: Sensitive Text
}
newCreateMeetingDialOut :: Text -> Text -> Text -> Text -> CreateMeetingDialOut
createMeetingDialOut_meetingId :: Lens' CreateMeetingDialOut Text
createMeetingDialOut_fromPhoneNumber :: Lens' CreateMeetingDialOut Text
createMeetingDialOut_toPhoneNumber :: Lens' CreateMeetingDialOut Text
createMeetingDialOut_joinToken :: Lens' CreateMeetingDialOut Text
data CreateMeetingDialOutResponse = CreateMeetingDialOutResponse' {
- transactionId :: Maybe Text
- httpStatus :: Int
}
newCreateMeetingDialOutResponse :: Int -> CreateMeetingDialOutResponse
createMeetingDialOutResponse_transactionId :: Lens' CreateMeetingDialOutResponse (Maybe Text)
createMeetingDialOutResponse_httpStatus :: Lens' CreateMeetingDialOutResponse Int

Creating a Request

data CreateMeetingDialOut Source #

See: newCreateMeetingDialOut smart constructor.

Constructors

CreateMeetingDialOut'
Fields meetingId :: Text The Amazon Chime SDK meeting ID. fromPhoneNumber :: Sensitive Text Phone number used as the caller ID when the remote party receives a call. toPhoneNumber :: Sensitive Text Phone number called when inviting someone to a meeting. joinToken :: Sensitive Text Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

Instances

Instances details

ToJSON CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods toJSON :: CreateMeetingDialOut -> Value # toEncoding :: CreateMeetingDialOut -> Encoding # toJSONList :: [CreateMeetingDialOut] -> Value # toEncodingList :: [CreateMeetingDialOut] -> Encoding #
ToHeaders CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods toHeaders :: CreateMeetingDialOut -> [Header] #
ToPath CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods toPath :: CreateMeetingDialOut -> ByteString #
ToQuery CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods toQuery :: CreateMeetingDialOut -> QueryString #
AWSRequest CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Associated Types type AWSResponse CreateMeetingDialOut # Methods request :: (Service -> Service) -> CreateMeetingDialOut -> Request CreateMeetingDialOut # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateMeetingDialOut -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateMeetingDialOut))) #
Generic CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Associated Types type Rep CreateMeetingDialOut :: Type -> Type # Methods from :: CreateMeetingDialOut -> Rep CreateMeetingDialOut x # to :: Rep CreateMeetingDialOut x -> CreateMeetingDialOut #
Show CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods showsPrec :: Int -> CreateMeetingDialOut -> ShowS # show :: CreateMeetingDialOut -> String # showList :: [CreateMeetingDialOut] -> ShowS #
NFData CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods rnf :: CreateMeetingDialOut -> () #
Eq CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods (==) :: CreateMeetingDialOut -> CreateMeetingDialOut -> Bool # (/=) :: CreateMeetingDialOut -> CreateMeetingDialOut -> Bool #
Hashable CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut Methods hashWithSalt :: Int -> CreateMeetingDialOut -> Int # hash :: CreateMeetingDialOut -> Int #
type AWSResponse CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut type AWSResponse CreateMeetingDialOut = CreateMeetingDialOutResponse
type Rep CreateMeetingDialOut Source #
Instance details Defined in Amazonka.Chime.CreateMeetingDialOut type Rep CreateMeetingDialOut = D1 ('MetaData "CreateMeetingDialOut" "Amazonka.Chime.CreateMeetingDialOut" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "CreateMeetingDialOut'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "meetingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "fromPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :: (S1 ('MetaSel ('Just "toPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "joinToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newCreateMeetingDialOut Source #

Arguments

:: Text	`CreateMeetingDialOut`
-> Text	`$sel:fromPhoneNumber:CreateMeetingDialOut'`
-> Text	`$sel:toPhoneNumber:CreateMeetingDialOut'`
-> Text	`CreateMeetingDialOut`
-> CreateMeetingDialOut

Create a value of CreateMeetingDialOut 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:

CreateMeetingDialOut, createMeetingDialOut_meetingId - The Amazon Chime SDK meeting ID.

$sel:fromPhoneNumber:CreateMeetingDialOut', createMeetingDialOut_fromPhoneNumber - Phone number used as the caller ID when the remote party receives a call.

$sel:toPhoneNumber:CreateMeetingDialOut', createMeetingDialOut_toPhoneNumber - Phone number called when inviting someone to a meeting.

CreateMeetingDialOut, createMeetingDialOut_joinToken - Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

Request Lenses

createMeetingDialOut_meetingId :: Lens' CreateMeetingDialOut Text Source #

The Amazon Chime SDK meeting ID.

createMeetingDialOut_fromPhoneNumber :: Lens' CreateMeetingDialOut Text Source #

Phone number used as the caller ID when the remote party receives a call.

createMeetingDialOut_toPhoneNumber :: Lens' CreateMeetingDialOut Text Source #

Phone number called when inviting someone to a meeting.

createMeetingDialOut_joinToken :: Lens' CreateMeetingDialOut Text Source #

Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

Destructuring the Response

data CreateMeetingDialOutResponse Source #

See: newCreateMeetingDialOutResponse smart constructor.

Constructors

CreateMeetingDialOutResponse'
Fields transactionId :: Maybe Text Unique ID that tracks API calls. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateMeetingDialOutResponse Source #

Arguments

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

Create a value of CreateMeetingDialOutResponse 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:

CreateMeetingDialOutResponse, createMeetingDialOutResponse_transactionId - Unique ID that tracks API calls.

$sel:httpStatus:CreateMeetingDialOutResponse', createMeetingDialOutResponse_httpStatus - The response's http status code.

Response Lenses

createMeetingDialOutResponse_transactionId :: Lens' CreateMeetingDialOutResponse (Maybe Text) Source #

Unique ID that tracks API calls.

createMeetingDialOutResponse_httpStatus :: Lens' CreateMeetingDialOutResponse Int Source #

The response's http status code.