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 |
Places an outbound call to a contact, and then initiates the flow. It
performs the actions in the flow that's specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the 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 to the quota
Amazon Connect campaigns.
Synopsis
- data StartOutboundVoiceContact = StartOutboundVoiceContact' {
- answerMachineDetectionConfig :: Maybe AnswerMachineDetectionConfig
- attributes :: Maybe (HashMap Text Text)
- campaignId :: Maybe Text
- clientToken :: Maybe Text
- queueId :: Maybe Text
- sourcePhoneNumber :: Maybe Text
- trafficType :: Maybe TrafficType
- destinationPhoneNumber :: Text
- contactFlowId :: Text
- instanceId :: Text
- newStartOutboundVoiceContact :: Text -> Text -> Text -> StartOutboundVoiceContact
- startOutboundVoiceContact_answerMachineDetectionConfig :: Lens' StartOutboundVoiceContact (Maybe AnswerMachineDetectionConfig)
- startOutboundVoiceContact_attributes :: Lens' StartOutboundVoiceContact (Maybe (HashMap Text Text))
- startOutboundVoiceContact_campaignId :: Lens' StartOutboundVoiceContact (Maybe Text)
- startOutboundVoiceContact_clientToken :: Lens' StartOutboundVoiceContact (Maybe Text)
- startOutboundVoiceContact_queueId :: Lens' StartOutboundVoiceContact (Maybe Text)
- startOutboundVoiceContact_sourcePhoneNumber :: Lens' StartOutboundVoiceContact (Maybe Text)
- startOutboundVoiceContact_trafficType :: Lens' StartOutboundVoiceContact (Maybe TrafficType)
- startOutboundVoiceContact_destinationPhoneNumber :: Lens' StartOutboundVoiceContact Text
- startOutboundVoiceContact_contactFlowId :: Lens' StartOutboundVoiceContact Text
- startOutboundVoiceContact_instanceId :: Lens' StartOutboundVoiceContact Text
- data StartOutboundVoiceContactResponse = StartOutboundVoiceContactResponse' {
- contactId :: Maybe Text
- httpStatus :: Int
- newStartOutboundVoiceContactResponse :: Int -> StartOutboundVoiceContactResponse
- startOutboundVoiceContactResponse_contactId :: Lens' StartOutboundVoiceContactResponse (Maybe Text)
- startOutboundVoiceContactResponse_httpStatus :: Lens' StartOutboundVoiceContactResponse Int
Creating a Request
data StartOutboundVoiceContact Source #
See: newStartOutboundVoiceContact
smart constructor.
StartOutboundVoiceContact' | |
|
Instances
newStartOutboundVoiceContact Source #
:: Text | |
-> Text | |
-> Text | |
-> 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: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 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:campaignId:StartOutboundVoiceContact'
, startOutboundVoiceContact_campaignId
- The campaign identifier of the outbound communication.
$sel:clientToken:StartOutboundVoiceContact'
, startOutboundVoiceContact_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK
populates this field. For more information about idempotency, see
Making retries safe with idempotent APIs.
The token is valid for 7 days after creation. If a contact is already
started, the contact ID is returned.
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 flow is used. If you do not
specify a queue, you must specify a source phone number.
$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: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:destinationPhoneNumber:StartOutboundVoiceContact'
, startOutboundVoiceContact_destinationPhoneNumber
- The phone number of the customer, in E.164 format.
StartOutboundVoiceContact
, startOutboundVoiceContact_contactFlowId
- The identifier of the 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 flow.
On the flow page, under the name of the 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
, 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_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 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_campaignId :: Lens' StartOutboundVoiceContact (Maybe Text) Source #
The campaign identifier of the outbound communication.
startOutboundVoiceContact_clientToken :: Lens' StartOutboundVoiceContact (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
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 flow is used. If you do not specify a queue, you must specify a source phone number.
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_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_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 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 flow. On the flow page, under the name of the 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.
StartOutboundVoiceContactResponse' | |
|
Instances
Generic StartOutboundVoiceContactResponse Source # | |
Read StartOutboundVoiceContactResponse Source # | |
Show StartOutboundVoiceContactResponse Source # | |
NFData StartOutboundVoiceContactResponse Source # | |
Defined in Amazonka.Connect.StartOutboundVoiceContact rnf :: StartOutboundVoiceContactResponse -> () # | |
Eq StartOutboundVoiceContactResponse Source # | |
type Rep StartOutboundVoiceContactResponse Source # | |
Defined in Amazonka.Connect.StartOutboundVoiceContact type Rep StartOutboundVoiceContactResponse = D1 ('MetaData "StartOutboundVoiceContactResponse" "Amazonka.Connect.StartOutboundVoiceContact" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" '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 #
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:
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.