public static interface StartOutboundVoiceContactRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, 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 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
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
StartOutboundVoiceContactRequest.Builder instanceId(String instanceId)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.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.
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.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.
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.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.
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.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.
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.
StartOutboundVoiceContactRequest.Builder answerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)
Configuration of the answering machine detection for this outbound call.
answerMachineDetectionConfig - Configuration of the answering machine detection for this outbound call.default StartOutboundVoiceContactRequest.Builder answerMachineDetectionConfig(Consumer<AnswerMachineDetectionConfig.Builder> answerMachineDetectionConfig)
Configuration of the answering machine detection for this outbound call.
This is a convenience method that creates an instance of theAnswerMachineDetectionConfig.Builder
avoiding the need to create one manually via AnswerMachineDetectionConfig.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to answerMachineDetectionConfig(AnswerMachineDetectionConfig).answerMachineDetectionConfig - a consumer that will call methods on AnswerMachineDetectionConfig.BuilderanswerMachineDetectionConfig(AnswerMachineDetectionConfig)StartOutboundVoiceContactRequest.Builder campaignId(String campaignId)
The campaign identifier of the outbound communication.
campaignId - The campaign identifier of the outbound communication.StartOutboundVoiceContactRequest.Builder trafficType(String 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.
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.TrafficType,
TrafficTypeStartOutboundVoiceContactRequest.Builder trafficType(TrafficType 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.
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.TrafficType,
TrafficTypeStartOutboundVoiceContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartOutboundVoiceContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.