public class StartOutboundVoiceContactRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
Places an outbound call to a contact, and then initiates the flow. It
performs the actions in the flow that's specified (in
ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then 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.
Campaign calls are not allowed by default. Before you can make a call with
TrafficType = CAMPAIGN, you must submit a service
quota increase request to the quota Amazon Connect campaigns.
| Constructor and Description |
|---|
StartOutboundVoiceContactRequest() |
| 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) |
AnswerMachineDetectionConfig |
getAnswerMachineDetectionConfig()
Configuration of the answering machine detection for this outbound call.
|
java.util.Map<java.lang.String,java.lang.String> |
getAttributes()
A custom key-value pair using an attribute map.
|
java.lang.String |
getCampaignId()
The campaign identifier of the outbound communication.
|
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 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.
|
java.lang.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(java.util.Map<java.lang.String,java.lang.String> attributes)
A custom key-value pair using an attribute map.
|
void |
setCampaignId(java.lang.String campaignId)
The campaign identifier of the outbound communication.
|
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 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.
|
void |
setTrafficType(java.lang.String trafficType)
Denotes the class of traffic.
|
void |
setTrafficType(TrafficType trafficType)
Denotes the class of traffic.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
StartOutboundVoiceContactRequest |
withAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)
Configuration of the answering machine detection for this outbound call.
|
StartOutboundVoiceContactRequest |
withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
A custom key-value pair using an attribute map.
|
StartOutboundVoiceContactRequest |
withCampaignId(java.lang.String campaignId)
The campaign identifier of the outbound communication.
|
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 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.
|
StartOutboundVoiceContactRequest |
withTrafficType(java.lang.String trafficType)
Denotes the class of traffic.
|
StartOutboundVoiceContactRequest |
withTrafficType(TrafficType trafficType)
Denotes the class of traffic.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getDestinationPhoneNumber()
The phone number of the customer, in E.164 format.
Constraints:
Pattern: \\+[1-9]\\d{1,14}$
The phone number of the customer, in E.164 format.
public void setDestinationPhoneNumber(java.lang.String destinationPhoneNumber)
The phone number of the customer, in E.164 format.
Constraints:
Pattern: \\+[1-9]\\d{1,14}$
destinationPhoneNumber - The phone number of the customer, in E.164 format.
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.
Constraints:
Pattern: \\+[1-9]\\d{1,14}$
destinationPhoneNumber - The phone number of the customer, in E.164 format.
public java.lang.String getContactFlowId()
The identifier of the 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 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
Constraints:
Length: - 500
The identifier of the 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 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 setContactFlowId(java.lang.String contactFlowId)
The identifier of the 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 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
Constraints:
Length: - 500
contactFlowId - The identifier of the 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 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 StartOutboundVoiceContactRequest withContactFlowId(java.lang.String contactFlowId)
The identifier of the 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 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
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 500
contactFlowId - The identifier of the 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 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 java.lang.String getInstanceId()
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Constraints:
Length: 1 - 100
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
public void setInstanceId(java.lang.String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Constraints:
Length: 1 - 100
instanceId - 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(java.lang.String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 100
instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
public java.lang.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.
Constraints:
Length: - 500
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 setClientToken(java.lang.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.
Constraints:
Length: - 500
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 StartOutboundVoiceContactRequest withClientToken(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 500
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 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.
Constraints:
Pattern: \\+[1-9]\\d{1,14}$
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 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.
Constraints:
Pattern: \\+[1-9]\\d{1,14}$
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 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.
Constraints:
Pattern: \\+[1-9]\\d{1,14}$
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 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 flow is used. If you do not specify a queue, you must specify a source phone number.
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 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 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 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 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.
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 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 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.
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 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 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(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 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.
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(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 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.
key - The key of the entry to be added into Attributes.value - The corresponding value of the entry to be added into
Attributes.public StartOutboundVoiceContactRequest clearAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public AnswerMachineDetectionConfig getAnswerMachineDetectionConfig()
Configuration of the answering machine detection for this outbound call.
Configuration of the answering machine detection for this outbound call.
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 StartOutboundVoiceContactRequest withAnswerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)
Configuration of the answering machine detection for this outbound call.
Returns a reference to this object so that method calls can be chained together.
answerMachineDetectionConfig - Configuration of the answering machine detection for this outbound call.
public java.lang.String getCampaignId()
The campaign identifier of the outbound communication.
Constraints:
Length: 1 - 100
The campaign identifier of the outbound communication.
public void setCampaignId(java.lang.String campaignId)
The campaign identifier of the outbound communication.
Constraints:
Length: 1 - 100
campaignId - The campaign identifier of the outbound communication.
public StartOutboundVoiceContactRequest withCampaignId(java.lang.String campaignId)
The campaign identifier of the outbound communication.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 100
campaignId - The campaign identifier of the outbound communication.
public java.lang.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.
Constraints:
Allowed Values: GENERAL, CAMPAIGN
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.
TrafficTypepublic void setTrafficType(java.lang.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.
Constraints:
Allowed Values: GENERAL, CAMPAIGN
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.
TrafficTypepublic StartOutboundVoiceContactRequest withTrafficType(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: GENERAL, CAMPAIGN
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.
TrafficTypepublic void setTrafficType(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.
Constraints:
Allowed Values: GENERAL, CAMPAIGN
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.
TrafficTypepublic 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: GENERAL, CAMPAIGN
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.
TrafficTypepublic java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object