/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.connect.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartOutboundVoiceContactRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The phone number of the customer, in E.164 format. *
*/ private String destinationPhoneNumber; /** ** 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 *
*/ private String contactFlowId; /** ** The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance. *
*/ private String instanceId; /** ** 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. *
*/ private String clientToken; /** ** 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. *
*/ private String sourcePhoneNumber; /** ** 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. *
*/ private String queueId; /** ** 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. *
*/ private java.util.Map* Configuration of the answering machine detection for this outbound call. *
*/ private AnswerMachineDetectionConfig answerMachineDetectionConfig; /** ** The campaign identifier of the outbound communication. *
*/ private String campaignId; /** *
* 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
.
*
* The phone number of the customer, in E.164 format. *
* * @param destinationPhoneNumber * The phone number of the customer, in E.164 format. */ public void setDestinationPhoneNumber(String destinationPhoneNumber) { this.destinationPhoneNumber = destinationPhoneNumber; } /** ** The phone number of the customer, in E.164 format. *
* * @return The phone number of the customer, in E.164 format. */ public String getDestinationPhoneNumber() { return this.destinationPhoneNumber; } /** ** The phone number of the customer, in E.164 format. *
* * @param destinationPhoneNumber * The phone number of the customer, in E.164 format. * @return Returns a reference to this object so that method calls can be chained together. */ public StartOutboundVoiceContactRequest withDestinationPhoneNumber(String destinationPhoneNumber) { setDestinationPhoneNumber(destinationPhoneNumber); return this; } /** ** 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 *
* * @param 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 void setContactFlowId(String contactFlowId) { this.contactFlowId = 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 *
* * @return 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 String getContactFlowId() { return this.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 *
* * @param 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 * @return Returns a reference to this object so that method calls can be chained together. */ public StartOutboundVoiceContactRequest withContactFlowId(String contactFlowId) { setContactFlowId(contactFlowId); return this; } /** *
* The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance. *
* * @param 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 setInstanceId(String instanceId) { this.instanceId = instanceId; } /** ** The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance. *
* * @return 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() { return this.instanceId; } /** ** The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance. *
* * @param instanceId * The identifier of the Amazon Connect instance. You can find the instance * ID in the Amazon Resource Name (ARN) of the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public StartOutboundVoiceContactRequest withInstanceId(String instanceId) { setInstanceId(instanceId); return this; } /** ** 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. *
* * @param 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 setClientToken(String clientToken) { this.clientToken = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartOutboundVoiceContactRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** ** 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. *
* * @param 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 setSourcePhoneNumber(String sourcePhoneNumber) { this.sourcePhoneNumber = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartOutboundVoiceContactRequest withSourcePhoneNumber(String sourcePhoneNumber) { setSourcePhoneNumber(sourcePhoneNumber); return this; } /** ** 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. *
* * @param 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 void setQueueId(String queueId) { this.queueId = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartOutboundVoiceContactRequest withQueueId(String queueId) { setQueueId(queueId); return this; } /** ** 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. *
* * @return 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 java.util.Map
* 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(java.util.Map
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartOutboundVoiceContactRequest withAttributes(java.util.Map
* Configuration of the answering machine detection for this outbound call.
*
* Configuration of the answering machine detection for this outbound call.
*
* Configuration of the answering machine detection for this outbound call.
*
* The campaign identifier of the outbound communication.
*
* The campaign identifier of the outbound communication.
*
* The campaign identifier of the outbound communication.
*
* Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The
* default value is
* Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The
* default value is
* Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The
* default value is
* 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
.
* @see TrafficType
*/
public void setTrafficType(String trafficType) {
this.trafficType = trafficType;
}
/**
* 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
.
* @see TrafficType
*/
public String getTrafficType() {
return this.trafficType;
}
/**
* 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
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrafficType
*/
public StartOutboundVoiceContactRequest withTrafficType(String trafficType) {
setTrafficType(trafficType);
return this;
}
/**
* 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
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrafficType
*/
public StartOutboundVoiceContactRequest withTrafficType(TrafficType trafficType) {
this.trafficType = trafficType.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDestinationPhoneNumber() != null)
sb.append("DestinationPhoneNumber: ").append(getDestinationPhoneNumber()).append(",");
if (getContactFlowId() != null)
sb.append("ContactFlowId: ").append(getContactFlowId()).append(",");
if (getInstanceId() != null)
sb.append("InstanceId: ").append(getInstanceId()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getSourcePhoneNumber() != null)
sb.append("SourcePhoneNumber: ").append(getSourcePhoneNumber()).append(",");
if (getQueueId() != null)
sb.append("QueueId: ").append(getQueueId()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes()).append(",");
if (getAnswerMachineDetectionConfig() != null)
sb.append("AnswerMachineDetectionConfig: ").append(getAnswerMachineDetectionConfig()).append(",");
if (getCampaignId() != null)
sb.append("CampaignId: ").append(getCampaignId()).append(",");
if (getTrafficType() != null)
sb.append("TrafficType: ").append(getTrafficType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartOutboundVoiceContactRequest == false)
return false;
StartOutboundVoiceContactRequest other = (StartOutboundVoiceContactRequest) obj;
if (other.getDestinationPhoneNumber() == null ^ this.getDestinationPhoneNumber() == null)
return false;
if (other.getDestinationPhoneNumber() != null && other.getDestinationPhoneNumber().equals(this.getDestinationPhoneNumber()) == false)
return false;
if (other.getContactFlowId() == null ^ this.getContactFlowId() == null)
return false;
if (other.getContactFlowId() != null && other.getContactFlowId().equals(this.getContactFlowId()) == false)
return false;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getSourcePhoneNumber() == null ^ this.getSourcePhoneNumber() == null)
return false;
if (other.getSourcePhoneNumber() != null && other.getSourcePhoneNumber().equals(this.getSourcePhoneNumber()) == false)
return false;
if (other.getQueueId() == null ^ this.getQueueId() == null)
return false;
if (other.getQueueId() != null && other.getQueueId().equals(this.getQueueId()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
if (other.getAnswerMachineDetectionConfig() == null ^ this.getAnswerMachineDetectionConfig() == null)
return false;
if (other.getAnswerMachineDetectionConfig() != null && other.getAnswerMachineDetectionConfig().equals(this.getAnswerMachineDetectionConfig()) == false)
return false;
if (other.getCampaignId() == null ^ this.getCampaignId() == null)
return false;
if (other.getCampaignId() != null && other.getCampaignId().equals(this.getCampaignId()) == false)
return false;
if (other.getTrafficType() == null ^ this.getTrafficType() == null)
return false;
if (other.getTrafficType() != null && other.getTrafficType().equals(this.getTrafficType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDestinationPhoneNumber() == null) ? 0 : getDestinationPhoneNumber().hashCode());
hashCode = prime * hashCode + ((getContactFlowId() == null) ? 0 : getContactFlowId().hashCode());
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getSourcePhoneNumber() == null) ? 0 : getSourcePhoneNumber().hashCode());
hashCode = prime * hashCode + ((getQueueId() == null) ? 0 : getQueueId().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
hashCode = prime * hashCode + ((getAnswerMachineDetectionConfig() == null) ? 0 : getAnswerMachineDetectionConfig().hashCode());
hashCode = prime * hashCode + ((getCampaignId() == null) ? 0 : getCampaignId().hashCode());
hashCode = prime * hashCode + ((getTrafficType() == null) ? 0 : getTrafficType().hashCode());
return hashCode;
}
@Override
public StartOutboundVoiceContactRequest clone() {
return (StartOutboundVoiceContactRequest) super.clone();
}
}