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 execute for the outbound call.
String	getDestinationPhoneNumber() The phone number, in E.164 format, of the customer to call with the outbound contact.
String	getInstanceId() The identifier for your Amazon Connect instance.
String	getQueueId() The queue to which to add the call.
String	getSourcePhoneNumber() The phone number, in E.164 format, associated with your Amazon Connect instance to use to place 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 execute for the outbound call.
void	setDestinationPhoneNumber(String destinationPhoneNumber) The phone number, in E.164 format, of the customer to call with the outbound contact.
void	setInstanceId(String instanceId) The identifier for your Amazon Connect instance.
void	setQueueId(String queueId) The queue to which to add the call.
void	setSourcePhoneNumber(String sourcePhoneNumber) The phone number, in E.164 format, associated with your Amazon Connect instance to use to place 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 execute for the outbound call.
StartOutboundVoiceContactRequest	withDestinationPhoneNumber(String destinationPhoneNumber) The phone number, in E.164 format, of the customer to call with the outbound contact.
StartOutboundVoiceContactRequest	withInstanceId(String instanceId) The identifier for your Amazon Connect instance.
StartOutboundVoiceContactRequest	withQueueId(String queueId) The queue to which to add the call.
StartOutboundVoiceContactRequest	withSourcePhoneNumber(String sourcePhoneNumber) The phone number, in E.164 format, associated with your Amazon Connect instance to use to place 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, in E.164 format, of the customer to call with the outbound contact.

Parameters:

destinationPhoneNumber - The phone number, in E.164 format, of the customer to call with the outbound contact.

getDestinationPhoneNumber

public String getDestinationPhoneNumber()

The phone number, in E.164 format, of the customer to call with the outbound contact.

Returns:

The phone number, in E.164 format, of the customer to call with the outbound contact.

withDestinationPhoneNumber

public StartOutboundVoiceContactRequest withDestinationPhoneNumber(String destinationPhoneNumber)

The phone number, in E.164 format, of the customer to call with the outbound contact.

Parameters:

destinationPhoneNumber - The phone number, in E.164 format, of the customer to call with the outbound contact.

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 execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.

To find the ContactFlowId, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181. The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.

Parameters:

contactFlowId - The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.

To find the ContactFlowId, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181. The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.

getContactFlowId

public String getContactFlowId()

The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.

To find the ContactFlowId, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181. The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.

Returns:

The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.

To find the ContactFlowId, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181. The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.

withContactFlowId

public StartOutboundVoiceContactRequest withContactFlowId(String contactFlowId)

The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.

To find the ContactFlowId, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181. The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.

Parameters:

contactFlowId - The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.

To find the ContactFlowId, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181. The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.

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 InstanceId value for your Amazon Connect instance, open the Amazon Connect console. Select the instance alias of the instance and view the instance ID in the Overview section. 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 InstanceId value for your Amazon Connect instance, open the Amazon Connect console. Select the instance alias of the instance and view the instance ID in the Overview section. 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 InstanceId value for your Amazon Connect instance, open the Amazon Connect console. Select the instance alias of the instance and view the instance ID in the Overview section. 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 InstanceId value for your Amazon Connect instance, open the Amazon Connect console. Select the instance alias of the instance and view the instance ID in the Overview section. 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 InstanceId value for your Amazon Connect instance, open the Amazon Connect console. Select the instance alias of the instance and view the instance ID in the Overview section. 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 InstanceId value for your Amazon Connect instance, open the Amazon Connect console. Select the instance alias of the instance and view the instance ID in the Overview section. 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 to place the outbound call.

Parameters:

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

getSourcePhoneNumber

public String getSourcePhoneNumber()

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

Returns:

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

withSourcePhoneNumber

public StartOutboundVoiceContactRequest withSourcePhoneNumber(String sourcePhoneNumber)

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

Parameters:

sourcePhoneNumber - The phone number, in E.164 format, associated with your Amazon Connect instance to use to place 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 which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId.

To find the QueueId, open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c.

Parameters:

queueId - The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId.

To find the QueueId, open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c.

getQueueId

public String getQueueId()

The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId.

To find the QueueId, open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c.

Returns:

The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId.

To find the QueueId, open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c.

withQueueId

public StartOutboundVoiceContactRequest withQueueId(String queueId)

The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId.

To find the QueueId, open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c.

Parameters:

queueId - The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId.

To find the QueueId, open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as 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, to 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, to 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, to 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, to 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, to 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, to 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()