com.amazonaws.services.connect.model

Class StartOutboundVoiceContactRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.StartOutboundVoiceContactRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartOutboundVoiceContactRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartOutboundVoiceContactRequest()

Method Summary

Modifier and Type	Method and Description
StartOutboundVoiceContactRequest	addAttributesEntry(java.lang.String key, java.lang.String value) A custom key-value pair using an attribute map.
StartOutboundVoiceContactRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() A custom key-value pair using an attribute map.
java.lang.String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
java.lang.String	getContactFlowId() The identifier of the contact flow for the outbound call.
java.lang.String	getDestinationPhoneNumber() The phone number of the customer, in E.164 format.
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
java.lang.String	getQueueId() The queue for the call.
java.lang.String	getSourcePhoneNumber() The phone number associated with the Amazon Connect instance, in E.164 format.
int	hashCode()
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A custom key-value pair using an attribute map.
void	setClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setContactFlowId(java.lang.String contactFlowId) The identifier of the contact flow for the outbound call.
void	setDestinationPhoneNumber(java.lang.String destinationPhoneNumber) The phone number of the customer, in E.164 format.
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setQueueId(java.lang.String queueId) The queue for the call.
void	setSourcePhoneNumber(java.lang.String sourcePhoneNumber) The phone number associated with the Amazon Connect instance, in E.164 format.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartOutboundVoiceContactRequest	withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A custom key-value pair using an attribute map.
StartOutboundVoiceContactRequest	withClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartOutboundVoiceContactRequest	withContactFlowId(java.lang.String contactFlowId) The identifier of the contact flow for the outbound call.
StartOutboundVoiceContactRequest	withDestinationPhoneNumber(java.lang.String destinationPhoneNumber) The phone number of the customer, in E.164 format.
StartOutboundVoiceContactRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
StartOutboundVoiceContactRequest	withQueueId(java.lang.String queueId) The queue for the call.
StartOutboundVoiceContactRequest	withSourcePhoneNumber(java.lang.String sourcePhoneNumber) The phone number associated with the Amazon Connect instance, in E.164 format.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartOutboundVoiceContactRequest

public StartOutboundVoiceContactRequest()

Method Detail

getDestinationPhoneNumber

public java.lang.String getDestinationPhoneNumber()

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

Returns:

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

setDestinationPhoneNumber

public void setDestinationPhoneNumber(java.lang.String destinationPhoneNumber)

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

Parameters:

destinationPhoneNumber -

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

withDestinationPhoneNumber

public StartOutboundVoiceContactRequest withDestinationPhoneNumber(java.lang.String destinationPhoneNumber)

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

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

Parameters:

destinationPhoneNumber -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getContactFlowId

public java.lang.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

Constraints:
Length: - 500

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

setContactFlowId

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

Constraints:
Length: - 500

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

withContactFlowId

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

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

Constraints:
Length: - 500

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:

A reference to this updated object so that method calls can be chained together.

getInstanceId

public java.lang.String getInstanceId()

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Returns:

The identifier of the Amazon Connect instance.

setInstanceId

public void setInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

The identifier of the Amazon Connect instance.

withInstanceId

public StartOutboundVoiceContactRequest withInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect instance.

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

Constraints:
Length: 1 - 100

Parameters:

instanceId -

The identifier of the Amazon Connect instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public java.lang.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. If the contact is disconnected, a new contact is started.

Constraints:
Length: - 500

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. If the contact is disconnected, a new contact is started.

setClientToken

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

Constraints:
Length: - 500

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.

withClientToken

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

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

Constraints:
Length: - 500

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:

A reference to this updated object so that method calls can be chained together.

getSourcePhoneNumber

public java.lang.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.

setSourcePhoneNumber

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

withSourcePhoneNumber

public StartOutboundVoiceContactRequest withSourcePhoneNumber(java.lang.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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getQueueId

public java.lang.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.

setQueueId

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

withQueueId

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

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

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:

A reference to this updated object so that method calls can be chained together.

getAttributes

public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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.

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

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:

A reference to this updated object so that method calls can be chained together.

addAttributesEntry

public StartOutboundVoiceContactRequest addAttributesEntry(java.lang.String key,
                                                           java.lang.String value)

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.

The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearAttributesEntries

public StartOutboundVoiceContactRequest clearAttributesEntries()

Removes all the entries added into Attributes.

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

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object