software.amazon.awssdk.services.connect.model

Interface StartOutboundVoiceContactRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>, SdkBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartOutboundVoiceContactRequest

public static interface StartOutboundVoiceContactRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>

Method Summary

Modifier and Type	Method and Description
StartOutboundVoiceContactRequest.Builder	attributes(Map<String,String> attributes) 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 of the contact flow for the outbound call.
StartOutboundVoiceContactRequest.Builder	destinationPhoneNumber(String destinationPhoneNumber) The phone number of the customer, in E.164 format.
StartOutboundVoiceContactRequest.Builder	instanceId(String instanceId) The identifier of the Amazon Connect instance.
StartOutboundVoiceContactRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartOutboundVoiceContactRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartOutboundVoiceContactRequest.Builder	queueId(String queueId) The queue for the call.
StartOutboundVoiceContactRequest.Builder	sourcePhoneNumber(String sourcePhoneNumber) The phone number associated with the Amazon Connect instance, in E.164 format.

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

destinationPhoneNumber

StartOutboundVoiceContactRequest.Builder destinationPhoneNumber(String destinationPhoneNumber)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

contactFlowId

StartOutboundVoiceContactRequest.Builder contactFlowId(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceId

StartOutboundVoiceContactRequest.Builder instanceId(String instanceId)

The identifier of the Amazon Connect instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourcePhoneNumber

StartOutboundVoiceContactRequest.Builder sourcePhoneNumber(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

queueId

StartOutboundVoiceContactRequest.Builder queueId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

attributes

StartOutboundVoiceContactRequest.Builder attributes(Map<String,String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

StartOutboundVoiceContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartOutboundVoiceContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder