com.amazonaws.services.connect.model

Class StartOutboundVoiceContactRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.StartOutboundVoiceContactRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartOutboundVoiceContactRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartOutboundVoiceContactRequest()

Method Summary

Modifier and Type	Method and Description
StartOutboundVoiceContactRequest	addAttributesEntry(String key, String value) Add a single Attributes entry
StartOutboundVoiceContactRequest	clearAttributesEntries() Removes all the entries added into Attributes.
StartOutboundVoiceContactRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AnswerMachineDetectionConfig	getAnswerMachineDetectionConfig() Configuration of the answering machine detection for this outbound call.
Map<String,String>	getAttributes() A custom key-value pair using an attribute map.
String	getCampaignId() The campaign identifier of the outbound communication.
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getContactFlowId() The identifier of the contact flow for the outbound call.
String	getDestinationPhoneNumber() The phone number of the customer, in E.164 format.
String	getInstanceId() The identifier of the Amazon Connect instance.
String	getQueueId() The queue for the call.
String	getSourcePhoneNumber() The phone number associated with the Amazon Connect instance, in E.164 format.
String	getTrafficType() Denotes the class of traffic.
int	hashCode()
void	setAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig) Configuration of the answering machine detection for this outbound call.
void	setAttributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
void	setCampaignId(String campaignId) The campaign identifier of the outbound communication.
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setContactFlowId(String contactFlowId) The identifier of the contact flow for the outbound call.
void	setDestinationPhoneNumber(String destinationPhoneNumber) The phone number of the customer, in E.164 format.
void	setInstanceId(String instanceId) The identifier of the Amazon Connect instance.
void	setQueueId(String queueId) The queue for the call.
void	setSourcePhoneNumber(String sourcePhoneNumber) The phone number associated with the Amazon Connect instance, in E.164 format.
void	setTrafficType(String trafficType) Denotes the class of traffic.
String	toString() Returns a string representation of this object.
StartOutboundVoiceContactRequest	withAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig) Configuration of the answering machine detection for this outbound call.
StartOutboundVoiceContactRequest	withAttributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
StartOutboundVoiceContactRequest	withCampaignId(String campaignId) The campaign identifier of the outbound communication.
StartOutboundVoiceContactRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartOutboundVoiceContactRequest	withContactFlowId(String contactFlowId) The identifier of the contact flow for the outbound call.
StartOutboundVoiceContactRequest	withDestinationPhoneNumber(String destinationPhoneNumber) The phone number of the customer, in E.164 format.
StartOutboundVoiceContactRequest	withInstanceId(String instanceId) The identifier of the Amazon Connect instance.
StartOutboundVoiceContactRequest	withQueueId(String queueId) The queue for the call.
StartOutboundVoiceContactRequest	withSourcePhoneNumber(String sourcePhoneNumber) The phone number associated with the Amazon Connect instance, in E.164 format.
StartOutboundVoiceContactRequest	withTrafficType(String trafficType) Denotes the class of traffic.
StartOutboundVoiceContactRequest	withTrafficType(TrafficType trafficType) Denotes the class of traffic.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartOutboundVoiceContactRequest

public StartOutboundVoiceContactRequest()

Method Detail

setDestinationPhoneNumber

public void setDestinationPhoneNumber(String destinationPhoneNumber)

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

Parameters:

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

getDestinationPhoneNumber

public String getDestinationPhoneNumber()

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

Returns:

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

withDestinationPhoneNumber

public StartOutboundVoiceContactRequest withDestinationPhoneNumber(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.

setContactFlowId

public void setContactFlowId(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

getContactFlowId

public String getContactFlowId()

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:

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

withContactFlowId

public StartOutboundVoiceContactRequest withContactFlowId(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.

setInstanceId

public void setInstanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

getInstanceId

public String getInstanceId()

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

withInstanceId

public StartOutboundVoiceContactRequest withInstanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

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

setClientToken

public void setClientToken(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.

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.

getClientToken

public String getClientToken()

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.

Returns:

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.

withClientToken

public StartOutboundVoiceContactRequest withClientToken(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.

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.

Returns:

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

setSourcePhoneNumber

public void setSourcePhoneNumber(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.

getSourcePhoneNumber

public String getSourcePhoneNumber()

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.

withSourcePhoneNumber

public StartOutboundVoiceContactRequest withSourcePhoneNumber(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.

setQueueId

public void setQueueId(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.

getQueueId

public String getQueueId()

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:

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.

withQueueId

public StartOutboundVoiceContactRequest withQueueId(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.

getAttributes

public Map<String,String> getAttributes()

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:

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.

setAttributes

public void setAttributes(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.

withAttributes

public StartOutboundVoiceContactRequest withAttributes(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.

addAttributesEntry

public StartOutboundVoiceContactRequest addAttributesEntry(String key,
                                                           String value)

Add a single Attributes entry

See Also:

withAttributes(java.util.Map<java.lang.String, java.lang.String>)

clearAttributesEntries

public StartOutboundVoiceContactRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

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

setAnswerMachineDetectionConfig

public void setAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)

Configuration of the answering machine detection for this outbound call.

Parameters:

answerMachineDetectionConfig - Configuration of the answering machine detection for this outbound call.

getAnswerMachineDetectionConfig

public AnswerMachineDetectionConfig getAnswerMachineDetectionConfig()

Configuration of the answering machine detection for this outbound call.

Returns:

Configuration of the answering machine detection for this outbound call.

withAnswerMachineDetectionConfig

public StartOutboundVoiceContactRequest withAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)

Configuration of the answering machine detection for this outbound call.

Parameters:

answerMachineDetectionConfig - Configuration of the answering machine detection for this outbound call.

Returns:

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

setCampaignId

public void setCampaignId(String campaignId)

The campaign identifier of the outbound communication.

Parameters:

campaignId - The campaign identifier of the outbound communication.

getCampaignId

public String getCampaignId()

The campaign identifier of the outbound communication.

Returns:

The campaign identifier of the outbound communication.

withCampaignId

public StartOutboundVoiceContactRequest withCampaignId(String campaignId)

The campaign identifier of the outbound communication.

Parameters:

campaignId - The campaign identifier of the outbound communication.

Returns:

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

setTrafficType

public void setTrafficType(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.

Parameters:

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.

See Also:

TrafficType

getTrafficType

public String getTrafficType()

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.

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

withTrafficType

public StartOutboundVoiceContactRequest withTrafficType(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.

Parameters:

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.

Returns:

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

See Also:

TrafficType

withTrafficType

public StartOutboundVoiceContactRequest withTrafficType(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.

Parameters:

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.

Returns:

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

See Also:

TrafficType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartOutboundVoiceContactRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()