Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
The StartOutboundVoiceContact
operation initiates a contact flow to place an outbound call to a customer.
There is a throttling limit placed on usage of the API that includes a RateLimit
of 2 per second, and a BurstLimit
of 5 per second.
If you are using an IAM account, it must have permissions to the connect:StartOutboundVoiceContact
action.
- startOutboundVoiceContact :: Text -> Text -> Text -> StartOutboundVoiceContact
- data StartOutboundVoiceContact
- sovcClientToken :: Lens' StartOutboundVoiceContact (Maybe Text)
- sovcQueueId :: Lens' StartOutboundVoiceContact (Maybe Text)
- sovcAttributes :: Lens' StartOutboundVoiceContact (HashMap Text Text)
- sovcSourcePhoneNumber :: Lens' StartOutboundVoiceContact (Maybe Text)
- sovcDestinationPhoneNumber :: Lens' StartOutboundVoiceContact Text
- sovcContactFlowId :: Lens' StartOutboundVoiceContact Text
- sovcInstanceId :: Lens' StartOutboundVoiceContact Text
- startOutboundVoiceContactResponse :: Int -> StartOutboundVoiceContactResponse
- data StartOutboundVoiceContactResponse
- sovcrsContactId :: Lens' StartOutboundVoiceContactResponse (Maybe Text)
- sovcrsResponseStatus :: Lens' StartOutboundVoiceContactResponse Int
Creating a Request
startOutboundVoiceContact Source #
:: Text | |
-> Text | |
-> Text | |
-> StartOutboundVoiceContact |
Creates a value of StartOutboundVoiceContact
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sovcClientToken
- 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. If the contact is disconnected, a new contact is started.sovcQueueId
- The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified byContactFlowId
. To find theQueueId
, open the queue to use in the Amazon Connect queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, theQueueId
value is the set of characters at the end of the URL, after "queue/", such asaeg40574-2d01-51c3-73d6-bf8624d2168c
.sovcAttributes
- Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters. For example, to play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:sovcSourcePhoneNumber
- The phone number, in E.164 format, associated with your Amazon Connect instance to use to place the outbound call.sovcDestinationPhoneNumber
- The phone number, in E.164 format, of the customer to call with the outbound contact.sovcContactFlowId
- The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported. To find theContactFlowId
, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following:https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow//b0b8f2dd-ed1b-4c44-af36-ce189a178181/
. At the end of the URL, you seecontact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181
. TheContactFlowID
for this contact flow isb0b8f2dd-ed1b-4c44-af36-ce189a178181
. Make sure to include only the GUID after the "contact-flow/" in your requests.sovcInstanceId
- The identifier for your Amazon Connect instance. To find theInstanceId
value for your Amazon Connect instance, open the Amazon Connect console . Select the instance alias of the instance and view the instance ID in the Overview section. For example, the instance ID is the set of characters at the end of the instance ARN, after "instance/", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
data StartOutboundVoiceContact Source #
See: startOutboundVoiceContact
smart constructor.
Request Lenses
sovcClientToken :: 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. If the contact is disconnected, a new contact is started.
sovcQueueId :: Lens' StartOutboundVoiceContact (Maybe Text) Source #
The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId
. To find the QueueId
, open the queue to use in the Amazon Connect queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the QueueId
value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c
.
sovcAttributes :: Lens' StartOutboundVoiceContact (HashMap Text Text) Source #
Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters. For example, to play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
sovcSourcePhoneNumber :: Lens' StartOutboundVoiceContact (Maybe Text) Source #
The phone number, in E.164 format, associated with your Amazon Connect instance to use to place the outbound call.
sovcDestinationPhoneNumber :: Lens' StartOutboundVoiceContact Text Source #
The phone number, in E.164 format, of the customer to call with the outbound contact.
sovcContactFlowId :: Lens' StartOutboundVoiceContact Text Source #
The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported. To find the ContactFlowId
, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow//b0b8f2dd-ed1b-4c44-af36-ce189a178181/
. At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181
. The ContactFlowID
for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181
. Make sure to include only the GUID after the "contact-flow/" in your requests.
sovcInstanceId :: Lens' StartOutboundVoiceContact Text Source #
The identifier for your Amazon Connect instance. To find the InstanceId
value for your Amazon Connect instance, open the Amazon Connect console . Select the instance alias of the instance and view the instance ID in the Overview section. For example, the instance ID is the set of characters at the end of the instance ARN, after "instance/", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
Destructuring the Response
startOutboundVoiceContactResponse Source #
Creates a value of StartOutboundVoiceContactResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sovcrsContactId
- The unique identifier of this contact within your Amazon Connect instance.sovcrsResponseStatus
- -- | The response status code.
data StartOutboundVoiceContactResponse Source #
See: startOutboundVoiceContactResponse
smart constructor.
Response Lenses
sovcrsContactId :: Lens' StartOutboundVoiceContactResponse (Maybe Text) Source #
The unique identifier of this contact within your Amazon Connect instance.
sovcrsResponseStatus :: Lens' StartOutboundVoiceContactResponse Int Source #
- - | The response status code.