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)
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)
Map<String,String>	getAttributes() Specify a custom key-value pair using an attribute map.
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getContactFlowId() The identifier for the contact flow to connect the outbound call to.
String	getDestinationPhoneNumber() The phone number of the customer in E.164 format.
String	getInstanceId() The identifier for your Amazon Connect instance.
String	getQueueId() The queue to add the call to.
String	getSourcePhoneNumber() The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
int	hashCode()
void	setAttributes(Map<String,String> attributes) Specify a custom key-value pair using an attribute map.
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 for the contact flow to connect the outbound call to.
void	setDestinationPhoneNumber(String destinationPhoneNumber) The phone number of the customer in E.164 format.
void	setInstanceId(String instanceId) The identifier for your Amazon Connect instance.
void	setQueueId(String queueId) The queue to add the call to.
void	setSourcePhoneNumber(String sourcePhoneNumber) The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StartOutboundVoiceContactRequest	withAttributes(Map<String,String> attributes) Specify a custom key-value pair using an attribute map.
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 for the contact flow to connect the outbound call to.
StartOutboundVoiceContactRequest	withDestinationPhoneNumber(String destinationPhoneNumber) The phone number of the customer in E.164 format.
StartOutboundVoiceContactRequest	withInstanceId(String instanceId) The identifier for your Amazon Connect instance.
StartOutboundVoiceContactRequest	withQueueId(String queueId) The queue to add the call to.
StartOutboundVoiceContactRequest	withSourcePhoneNumber(String sourcePhoneNumber) The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

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 for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

Parameters:

contactFlowId - The identifier for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

getContactFlowId

public String getContactFlowId()

The identifier for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

Returns:

The identifier for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

withContactFlowId

public StartOutboundVoiceContactRequest withContactFlowId(String contactFlowId)

The identifier for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

Parameters:

contactFlowId - The identifier for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

Returns:

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

setInstanceId

public void setInstanceId(String instanceId)

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Parameters:

instanceId - The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

getInstanceId

public String getInstanceId()

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

withInstanceId

public StartOutboundVoiceContactRequest withInstanceId(String instanceId)

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Parameters:

instanceId - The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

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

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

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.

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

setSourcePhoneNumber

public void setSourcePhoneNumber(String sourcePhoneNumber)

The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

Parameters:

sourcePhoneNumber - The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

getSourcePhoneNumber

public String getSourcePhoneNumber()

The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

Returns:

The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

withSourcePhoneNumber

public StartOutboundVoiceContactRequest withSourcePhoneNumber(String sourcePhoneNumber)

The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

Parameters:

sourcePhoneNumber - The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

Returns:

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

setQueueId

public void setQueueId(String queueId)

The queue to add the call to. 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 used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

Parameters:

queueId - The queue to add the call to. 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 used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

getQueueId

public String getQueueId()

The queue to add the call to. 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 used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

Returns:

The queue to add the call to. 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 used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

withQueueId

public StartOutboundVoiceContactRequest withQueueId(String queueId)

The queue to add the call to. 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 used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

Parameters:

queueId - The queue to add the call to. 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 used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

Returns:

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

getAttributes

public Map<String,String> getAttributes()

Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters.

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

Returns:

Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters.

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

setAttributes

public void setAttributes(Map<String,String> attributes)

Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters.

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

Parameters:

attributes - Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters.

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

withAttributes

public StartOutboundVoiceContactRequest withAttributes(Map<String,String> attributes)

Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters.

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

Parameters:

attributes - Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters.

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

Returns:

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

addAttributesEntry

public StartOutboundVoiceContactRequest addAttributesEntry(String key,
                                                           String value)

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.

toString

public String toString()

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

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()