@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartOutboundVoiceContactRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartOutboundVoiceContactRequest() |
Modifier and Type | Method and Description |
---|---|
StartOutboundVoiceContactRequest |
addAttributesEntry(String key,
String value)
Add a single Attributes entry
|
StartOutboundVoiceContactRequest |
addReferencesEntry(String key,
Reference value)
Add a single References entry
|
StartOutboundVoiceContactRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
StartOutboundVoiceContactRequest |
clearReferencesEntries()
Removes all the entries added into References.
|
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 flow for the outbound call.
|
String |
getDescription()
A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
|
String |
getDestinationPhoneNumber()
The phone number of the customer, in E.164 format.
|
String |
getInstanceId()
The identifier of the Amazon Connect instance.
|
String |
getName()
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
|
String |
getQueueId()
The queue for the call.
|
Map<String,Reference> |
getReferences()
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
|
String |
getRelatedContactId()
The
contactId that is related to this contact. |
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 flow for the outbound call.
|
void |
setDescription(String description)
A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
|
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 |
setName(String name)
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
|
void |
setQueueId(String queueId)
The queue for the call.
|
void |
setReferences(Map<String,Reference> references)
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
|
void |
setRelatedContactId(String relatedContactId)
The
contactId that is related to this contact. |
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 flow for the outbound call.
|
StartOutboundVoiceContactRequest |
withDescription(String description)
A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
|
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 |
withName(String name)
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
|
StartOutboundVoiceContactRequest |
withQueueId(String queueId)
The queue for the call.
|
StartOutboundVoiceContactRequest |
withReferences(Map<String,Reference> references)
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
|
StartOutboundVoiceContactRequest |
withRelatedContactId(String relatedContactId)
The
contactId that is related to this contact. |
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.
|
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
public void setName(String name)
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
name
- The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).public String getName()
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
public StartOutboundVoiceContactRequest withName(String name)
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
name
- The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).public void setDescription(String description)
A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
description
- A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).public String getDescription()
A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
public StartOutboundVoiceContactRequest withDescription(String description)
A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
description
- A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).public Map<String,Reference> getReferences()
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during voice
contact creation.
URL
| NUMBER
|
STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported
reference type during voice contact creation.public void setReferences(Map<String,Reference> references)
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during voice
contact creation.
references
- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the
following reference types at the time of creation: URL
| NUMBER
|
STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported
reference type during voice contact creation.public StartOutboundVoiceContactRequest withReferences(Map<String,Reference> references)
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during voice
contact creation.
references
- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the
following reference types at the time of creation: URL
| NUMBER
|
STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported
reference type during voice contact creation.public StartOutboundVoiceContactRequest addReferencesEntry(String key, Reference value)
public StartOutboundVoiceContactRequest clearReferencesEntries()
public void setRelatedContactId(String relatedContactId)
The contactId
that is related to this contact. Linking voice, task, or chat by using
RelatedContactID
copies over contact attributes from the related contact to the new contact. All
updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no
limits to the number of contacts that can be linked by using RelatedContactId
.
relatedContactId
- The contactId
that is related to this contact. Linking voice, task, or chat by using
RelatedContactID
copies over contact attributes from the related contact to the new contact.
All updates to user-defined attributes in the new contact are limited to the individual contact ID. There
are no limits to the number of contacts that can be linked by using RelatedContactId
.public String getRelatedContactId()
The contactId
that is related to this contact. Linking voice, task, or chat by using
RelatedContactID
copies over contact attributes from the related contact to the new contact. All
updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no
limits to the number of contacts that can be linked by using RelatedContactId
.
contactId
that is related to this contact. Linking voice, task, or chat by using
RelatedContactID
copies over contact attributes from the related contact to the new contact.
All updates to user-defined attributes in the new contact are limited to the individual contact ID. There
are no limits to the number of contacts that can be linked by using RelatedContactId
.public StartOutboundVoiceContactRequest withRelatedContactId(String relatedContactId)
The contactId
that is related to this contact. Linking voice, task, or chat by using
RelatedContactID
copies over contact attributes from the related contact to the new contact. All
updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no
limits to the number of contacts that can be linked by using RelatedContactId
.
relatedContactId
- The contactId
that is related to this contact. Linking voice, task, or chat by using
RelatedContactID
copies over contact attributes from the related contact to the new contact.
All updates to user-defined attributes in the new contact are limited to the individual contact ID. There
are no limits to the number of contacts that can be linked by using RelatedContactId
.public void setDestinationPhoneNumber(String destinationPhoneNumber)
The phone number of the customer, in E.164 format.
destinationPhoneNumber
- The phone number of the customer, in E.164 format.public String getDestinationPhoneNumber()
The phone number of the customer, in E.164 format.
public StartOutboundVoiceContactRequest withDestinationPhoneNumber(String destinationPhoneNumber)
The phone number of the customer, in E.164 format.
destinationPhoneNumber
- The phone number of the customer, in E.164 format.public void setContactFlowId(String contactFlowId)
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, 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
contactFlowId
- The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin
website, 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
public String getContactFlowId()
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, 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
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
public StartOutboundVoiceContactRequest withContactFlowId(String contactFlowId)
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, 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
contactFlowId
- The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin
website, 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
public void setInstanceId(String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
instanceId
- The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.public String getInstanceId()
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
public StartOutboundVoiceContactRequest withInstanceId(String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
instanceId
- The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.public void setClientToken(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.
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.public String getClientToken()
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.
public StartOutboundVoiceContactRequest withClientToken(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.
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.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.
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.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.
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.
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.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 flow is used. If you do not specify a queue, you must specify a source phone number.
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.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 flow is used. If you do not specify a queue, you must specify a source phone number.
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 flow is used. If you do not specify a queue, you must specify a source phone number.
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.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 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.
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.
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 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.
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.
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 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.
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.
public StartOutboundVoiceContactRequest addAttributesEntry(String key, String value)
public StartOutboundVoiceContactRequest clearAttributesEntries()
public void setAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)
Configuration of the answering machine detection for this outbound call.
answerMachineDetectionConfig
- Configuration of the answering machine detection for this outbound call.public AnswerMachineDetectionConfig getAnswerMachineDetectionConfig()
Configuration of the answering machine detection for this outbound call.
public StartOutboundVoiceContactRequest withAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)
Configuration of the answering machine detection for this outbound call.
answerMachineDetectionConfig
- Configuration of the answering machine detection for this outbound call.public void setCampaignId(String campaignId)
The campaign identifier of the outbound communication.
campaignId
- The campaign identifier of the outbound communication.public String getCampaignId()
The campaign identifier of the outbound communication.
public StartOutboundVoiceContactRequest withCampaignId(String campaignId)
The campaign identifier of the outbound communication.
campaignId
- The campaign identifier of the outbound communication.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
.
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
.TrafficType
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
.
GENERAL
. Use CAMPAIGN
if
EnableAnswerMachineDetection
is set to true
. For all other cases, use
GENERAL
.TrafficType
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
.
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
.TrafficType
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
.
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
.TrafficType
public String toString()
toString
in class Object
Object.toString()
public StartOutboundVoiceContactRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Privacy | Site terms | Cookie preferences | © 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.