public static interface StartOutboundVoiceContactRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>
| Modifier and Type | Method and Description |
|---|---|
StartOutboundVoiceContactRequest.Builder |
attributes(Map<String,String> attributes)
Specify a custom key-value pair using an attribute map.
|
StartOutboundVoiceContactRequest.Builder |
clientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
StartOutboundVoiceContactRequest.Builder |
contactFlowId(String contactFlowId)
The identifier for the contact flow to connect the outbound call to.
|
StartOutboundVoiceContactRequest.Builder |
destinationPhoneNumber(String destinationPhoneNumber)
The phone number of the customer in E.164 format.
|
StartOutboundVoiceContactRequest.Builder |
instanceId(String instanceId)
The identifier for your Amazon Connect instance.
|
StartOutboundVoiceContactRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
StartOutboundVoiceContactRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
StartOutboundVoiceContactRequest.Builder |
queueId(String queueId)
The queue to add the call to.
|
StartOutboundVoiceContactRequest.Builder |
sourcePhoneNumber(String sourcePhoneNumber)
The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
|
buildoverrideConfigurationcopyapplyMutation, buildStartOutboundVoiceContactRequest.Builder destinationPhoneNumber(String destinationPhoneNumber)
The phone number of the customer in E.164 format.
destinationPhoneNumber - The phone number of the customer in E.164 format.StartOutboundVoiceContactRequest.Builder contactFlowId(String contactFlowId)
The identifier for the contact flow to connect the outbound call to.
To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact
flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the
contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as
78ea8fd5-2659-4f2b-b528-699760ccfc1b.
contactFlowId - The identifier for the contact flow to connect the outbound call to.
To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect
contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL.
For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/'
such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.
StartOutboundVoiceContactRequest.Builder instanceId(String instanceId)
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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.
instanceId - The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console
and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance
ID is displayed in the Overview section of your instance settings. 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.StartOutboundVoiceContactRequest.Builder clientToken(String 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. If the contact is disconnected, a new contact is started.
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.
If the contact is disconnected, a new contact is started.StartOutboundVoiceContactRequest.Builder sourcePhoneNumber(String sourcePhoneNumber)
The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
sourcePhoneNumber - The phone number, in E.164 format, associated with your Amazon Connect instance to use for the
outbound call.StartOutboundVoiceContactRequest.Builder queueId(String queueId)
The queue to add the call to. 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 used will be the queue defined in the contact flow.
To find the QueueId, open the queue you want 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 queue ID is the set of
characters at the end of the URL, after 'queue/' such as
queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
queueId - The queue to add the call to. 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 used will be the queue defined
in the contact flow.
To find the QueueId, open the queue you want 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 queue ID is
the set of characters at the end of the URL, after 'queue/' such as
queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
StartOutboundVoiceContactRequest.Builder attributes(Map<String,String> attributes)
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, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
attributes - 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, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
StartOutboundVoiceContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.StartOutboundVoiceContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.