software.amazon.awssdk.services.connect.model

Class StartOutboundVoiceContactRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.StartOutboundVoiceContactRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartOutboundVoiceContactRequest
extends ConnectRequest
implements ToCopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartOutboundVoiceContactRequest.Builder

Method Summary

Modifier and Type	Method and Description
AnswerMachineDetectionConfig	answerMachineDetectionConfig() Configuration of the answering machine detection for this outbound call.
Map<String,String>	attributes() A custom key-value pair using an attribute map.
static StartOutboundVoiceContactRequest.Builder	builder()
String	campaignId() The campaign identifier of the outbound communication.
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	contactFlowId() The identifier of the flow for the outbound call.
String	destinationPhoneNumber() The phone number of the customer, in E.164 format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
String	instanceId() The identifier of the Amazon Connect instance.
String	queueId() The queue for the call.
List<SdkField<?>>	sdkFields()
static Class<? extends StartOutboundVoiceContactRequest.Builder>	serializableBuilderClass()
String	sourcePhoneNumber() The phone number associated with the Amazon Connect instance, in E.164 format.
StartOutboundVoiceContactRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrafficType	trafficType() Denotes the class of traffic.
String	trafficTypeAsString() Denotes the class of traffic.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

destinationPhoneNumber

public final String destinationPhoneNumber()

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

Returns:

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

contactFlowId

public final String 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

Returns:

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

instanceId

public final String instanceId()

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

clientToken

public final String 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.

Returns:

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.

sourcePhoneNumber

public final 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.

Returns:

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.

queueId

public final 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 flow is used. If you do not specify a queue, you must specify a source phone number.

Returns:

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.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attributes

public final 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 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

Returns:

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.

answerMachineDetectionConfig

public final AnswerMachineDetectionConfig answerMachineDetectionConfig()

Configuration of the answering machine detection for this outbound call.

Returns:

Configuration of the answering machine detection for this outbound call.

campaignId

public final String campaignId()

The campaign identifier of the outbound communication.

Returns:

The campaign identifier of the outbound communication.

trafficType

public final 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.

If the service returns an enum value that is not available in the current SDK version, trafficType will return TrafficType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficTypeAsString().

Returns:

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.

See Also:

TrafficType

trafficTypeAsString

public final String trafficTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, trafficType will return TrafficType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficTypeAsString().

Returns:

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.

See Also:

TrafficType

toBuilder

public StartOutboundVoiceContactRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static StartOutboundVoiceContactRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartOutboundVoiceContactRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo