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.Connect.StartOutboundVoiceContact

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Synopsis

Creating a Request

data StartOutboundVoiceContact Source #

See: newStartOutboundVoiceContact smart constructor.

Constructors

StartOutboundVoiceContact'

Fields

answerMachineDetectionConfig :: Maybe AnswerMachineDetectionConfig
Configuration of the answering machine detection for this outbound call.
clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
trafficType :: Maybe TrafficType
Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.
campaignId :: Maybe Text
The campaign identifier of the outbound communication.
queueId :: Maybe Text
The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
attributes :: Maybe (HashMap Text Text)
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
sourcePhoneNumber :: Maybe Text
The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
destinationPhoneNumber :: Text
The phone number of the customer, in E.164 format.
contactFlowId :: Text
The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

Eq StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods (==) :: StartOutboundVoiceContact -> StartOutboundVoiceContact -> Bool # (/=) :: StartOutboundVoiceContact -> StartOutboundVoiceContact -> Bool #
Read StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods readsPrec :: Int -> ReadS StartOutboundVoiceContact # readList :: ReadS [StartOutboundVoiceContact] # readPrec :: ReadPrec StartOutboundVoiceContact # readListPrec :: ReadPrec [StartOutboundVoiceContact] #
Show StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods showsPrec :: Int -> StartOutboundVoiceContact -> ShowS # show :: StartOutboundVoiceContact -> String # showList :: [StartOutboundVoiceContact] -> ShowS #
Generic StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Associated Types type Rep StartOutboundVoiceContact :: Type -> Type # Methods from :: StartOutboundVoiceContact -> Rep StartOutboundVoiceContact x # to :: Rep StartOutboundVoiceContact x -> StartOutboundVoiceContact #
NFData StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods rnf :: StartOutboundVoiceContact -> () #
Hashable StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods hashWithSalt :: Int -> StartOutboundVoiceContact -> Int # hash :: StartOutboundVoiceContact -> Int #
ToJSON StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods toJSON :: StartOutboundVoiceContact -> Value # toEncoding :: StartOutboundVoiceContact -> Encoding # toJSONList :: [StartOutboundVoiceContact] -> Value # toEncodingList :: [StartOutboundVoiceContact] -> Encoding #
AWSRequest StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Associated Types type AWSResponse StartOutboundVoiceContact # Methods request :: StartOutboundVoiceContact -> Request StartOutboundVoiceContact # response :: MonadResource m => Logger -> Service -> Proxy StartOutboundVoiceContact -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartOutboundVoiceContact))) #
ToHeaders StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods toHeaders :: StartOutboundVoiceContact -> [Header] #
ToPath StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods toPath :: StartOutboundVoiceContact -> ByteString #
ToQuery StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact Methods toQuery :: StartOutboundVoiceContact -> QueryString #
type Rep StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact type Rep StartOutboundVoiceContact = D1 ('MetaData "StartOutboundVoiceContact" "Amazonka.Connect.StartOutboundVoiceContact" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "StartOutboundVoiceContact'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "answerMachineDetectionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnswerMachineDetectionConfig)) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "trafficType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrafficType)) :: (S1 ('MetaSel ('Just "campaignId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queueId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "sourcePhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "destinationPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "contactFlowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartOutboundVoiceContact Source #
Instance details Defined in Amazonka.Connect.StartOutboundVoiceContact type AWSResponse StartOutboundVoiceContact = StartOutboundVoiceContactResponse

newStartOutboundVoiceContact Source #

Arguments

:: Text	`$sel:destinationPhoneNumber:StartOutboundVoiceContact'`
-> Text	`$sel:contactFlowId:StartOutboundVoiceContact'`
-> Text	`$sel:instanceId:StartOutboundVoiceContact'`
-> StartOutboundVoiceContact

Create a value of StartOutboundVoiceContact 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:answerMachineDetectionConfig:StartOutboundVoiceContact', startOutboundVoiceContact_answerMachineDetectionConfig - Configuration of the answering machine detection for this outbound call.

$sel:clientToken:StartOutboundVoiceContact', startOutboundVoiceContact_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

$sel:trafficType:StartOutboundVoiceContact', startOutboundVoiceContact_trafficType - Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

$sel:campaignId:StartOutboundVoiceContact', startOutboundVoiceContact_campaignId - The campaign identifier of the outbound communication.

$sel:queueId:StartOutboundVoiceContact', startOutboundVoiceContact_queueId - The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

$sel:attributes:StartOutboundVoiceContact', startOutboundVoiceContact_attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

$sel:sourcePhoneNumber:StartOutboundVoiceContact', startOutboundVoiceContact_sourcePhoneNumber - The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

$sel:destinationPhoneNumber:StartOutboundVoiceContact', startOutboundVoiceContact_destinationPhoneNumber - The phone number of the customer, in E.164 format.

$sel:contactFlowId:StartOutboundVoiceContact', startOutboundVoiceContact_contactFlowId - The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

$sel:instanceId:StartOutboundVoiceContact', startOutboundVoiceContact_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

startOutboundVoiceContact_answerMachineDetectionConfig :: Lens' StartOutboundVoiceContact (Maybe AnswerMachineDetectionConfig) Source #

Configuration of the answering machine detection for this outbound call.

startOutboundVoiceContact_clientToken :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

startOutboundVoiceContact_trafficType :: Lens' StartOutboundVoiceContact (Maybe TrafficType) Source #

Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

startOutboundVoiceContact_campaignId :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

The campaign identifier of the outbound communication.

startOutboundVoiceContact_queueId :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

startOutboundVoiceContact_attributes :: Lens' StartOutboundVoiceContact (Maybe (HashMap Text Text)) Source #

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

startOutboundVoiceContact_sourcePhoneNumber :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

startOutboundVoiceContact_destinationPhoneNumber :: Lens' StartOutboundVoiceContact Text Source #

The phone number of the customer, in E.164 format.

startOutboundVoiceContact_contactFlowId :: Lens' StartOutboundVoiceContact Text Source #

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

startOutboundVoiceContact_instanceId :: Lens' StartOutboundVoiceContact Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data StartOutboundVoiceContactResponse Source #

See: newStartOutboundVoiceContactResponse smart constructor.

Constructors

StartOutboundVoiceContactResponse'
Fields contactId :: Maybe Text The identifier of this contact within the Amazon Connect instance. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartOutboundVoiceContactResponse Source #

Arguments

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

Create a value of StartOutboundVoiceContactResponse 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:contactId:StartOutboundVoiceContactResponse', startOutboundVoiceContactResponse_contactId - The identifier of this contact within the Amazon Connect instance.

$sel:httpStatus:StartOutboundVoiceContactResponse', startOutboundVoiceContactResponse_httpStatus - The response's http status code.

Response Lenses

startOutboundVoiceContactResponse_contactId :: Lens' StartOutboundVoiceContactResponse (Maybe Text) Source #

The identifier of this contact within the Amazon Connect instance.

startOutboundVoiceContactResponse_httpStatus :: Lens' StartOutboundVoiceContactResponse Int Source #

The response's http status code.