This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-connect/include/aws/connect/model/StartOutboundVoiceContactRequest.h

491 lines
23 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/connect/Connect_EXPORTS.h>
#include <aws/connect/ConnectRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <utility>
#include <aws/core/utils/UUID.h>
namespace Aws
{
namespace Connect
{
namespace Model
{
/**
*/
class AWS_CONNECT_API StartOutboundVoiceContactRequest : public ConnectRequest
{
public:
StartOutboundVoiceContactRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "StartOutboundVoiceContact"; }
Aws::String SerializePayload() const override;
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline const Aws::String& GetDestinationPhoneNumber() const{ return m_destinationPhoneNumber; }
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline bool DestinationPhoneNumberHasBeenSet() const { return m_destinationPhoneNumberHasBeenSet; }
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline void SetDestinationPhoneNumber(const Aws::String& value) { m_destinationPhoneNumberHasBeenSet = true; m_destinationPhoneNumber = value; }
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline void SetDestinationPhoneNumber(Aws::String&& value) { m_destinationPhoneNumberHasBeenSet = true; m_destinationPhoneNumber = std::move(value); }
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline void SetDestinationPhoneNumber(const char* value) { m_destinationPhoneNumberHasBeenSet = true; m_destinationPhoneNumber.assign(value); }
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline StartOutboundVoiceContactRequest& WithDestinationPhoneNumber(const Aws::String& value) { SetDestinationPhoneNumber(value); return *this;}
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline StartOutboundVoiceContactRequest& WithDestinationPhoneNumber(Aws::String&& value) { SetDestinationPhoneNumber(std::move(value)); return *this;}
/**
* <p>The phone number of the customer, in E.164 format.</p>
*/
inline StartOutboundVoiceContactRequest& WithDestinationPhoneNumber(const char* value) { SetDestinationPhoneNumber(value); return *this;}
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline const Aws::String& GetContactFlowId() const{ return m_contactFlowId; }
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline bool ContactFlowIdHasBeenSet() const { return m_contactFlowIdHasBeenSet; }
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline void SetContactFlowId(const Aws::String& value) { m_contactFlowIdHasBeenSet = true; m_contactFlowId = value; }
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline void SetContactFlowId(Aws::String&& value) { m_contactFlowIdHasBeenSet = true; m_contactFlowId = std::move(value); }
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline void SetContactFlowId(const char* value) { m_contactFlowIdHasBeenSet = true; m_contactFlowId.assign(value); }
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline StartOutboundVoiceContactRequest& WithContactFlowId(const Aws::String& value) { SetContactFlowId(value); return *this;}
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline StartOutboundVoiceContactRequest& WithContactFlowId(Aws::String&& value) { SetContactFlowId(std::move(value)); return *this;}
/**
* <p>The identifier of the contact flow for the outbound call.</p>
*/
inline StartOutboundVoiceContactRequest& WithContactFlowId(const char* value) { SetContactFlowId(value); return *this;}
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline const Aws::String& GetInstanceId() const{ return m_instanceId; }
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline bool InstanceIdHasBeenSet() const { return m_instanceIdHasBeenSet; }
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline void SetInstanceId(const Aws::String& value) { m_instanceIdHasBeenSet = true; m_instanceId = value; }
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline void SetInstanceId(Aws::String&& value) { m_instanceIdHasBeenSet = true; m_instanceId = std::move(value); }
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline void SetInstanceId(const char* value) { m_instanceIdHasBeenSet = true; m_instanceId.assign(value); }
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline StartOutboundVoiceContactRequest& WithInstanceId(const Aws::String& value) { SetInstanceId(value); return *this;}
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline StartOutboundVoiceContactRequest& WithInstanceId(Aws::String&& value) { SetInstanceId(std::move(value)); return *this;}
/**
* <p>The identifier of the Amazon Connect instance.</p>
*/
inline StartOutboundVoiceContactRequest& WithInstanceId(const char* value) { SetInstanceId(value); return *this;}
/**
* <p>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.</p>
*/
inline const Aws::String& GetClientToken() const{ return m_clientToken; }
/**
* <p>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.</p>
*/
inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
/**
* <p>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.</p>
*/
inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; }
/**
* <p>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.</p>
*/
inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); }
/**
* <p>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.</p>
*/
inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); }
/**
* <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;}
/**
* <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;}
/**
* <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;}
/**
* <p>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.</p>
*/
inline const Aws::String& GetSourcePhoneNumber() const{ return m_sourcePhoneNumber; }
/**
* <p>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.</p>
*/
inline bool SourcePhoneNumberHasBeenSet() const { return m_sourcePhoneNumberHasBeenSet; }
/**
* <p>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.</p>
*/
inline void SetSourcePhoneNumber(const Aws::String& value) { m_sourcePhoneNumberHasBeenSet = true; m_sourcePhoneNumber = value; }
/**
* <p>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.</p>
*/
inline void SetSourcePhoneNumber(Aws::String&& value) { m_sourcePhoneNumberHasBeenSet = true; m_sourcePhoneNumber = std::move(value); }
/**
* <p>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.</p>
*/
inline void SetSourcePhoneNumber(const char* value) { m_sourcePhoneNumberHasBeenSet = true; m_sourcePhoneNumber.assign(value); }
/**
* <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithSourcePhoneNumber(const Aws::String& value) { SetSourcePhoneNumber(value); return *this;}
/**
* <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithSourcePhoneNumber(Aws::String&& value) { SetSourcePhoneNumber(std::move(value)); return *this;}
/**
* <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithSourcePhoneNumber(const char* value) { SetSourcePhoneNumber(value); return *this;}
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline const Aws::String& GetQueueId() const{ return m_queueId; }
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline bool QueueIdHasBeenSet() const { return m_queueIdHasBeenSet; }
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline void SetQueueId(const Aws::String& value) { m_queueIdHasBeenSet = true; m_queueId = value; }
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline void SetQueueId(Aws::String&& value) { m_queueIdHasBeenSet = true; m_queueId = std::move(value); }
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline void SetQueueId(const char* value) { m_queueIdHasBeenSet = true; m_queueId.assign(value); }
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline StartOutboundVoiceContactRequest& WithQueueId(const Aws::String& value) { SetQueueId(value); return *this;}
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline StartOutboundVoiceContactRequest& WithQueueId(Aws::String&& value) { SetQueueId(std::move(value)); return *this;}
/**
* <p>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 contact flow is used. If you do not specify a
* queue, you must specify a source phone number.</p>
*/
inline StartOutboundVoiceContactRequest& WithQueueId(const char* value) { SetQueueId(value); return *this;}
/**
* <p>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.</p> <p>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.</p>
*/
inline const Aws::Map<Aws::String, Aws::String>& GetAttributes() const{ return m_attributes; }
/**
* <p>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.</p> <p>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.</p>
*/
inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; }
/**
* <p>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.</p> <p>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.</p>
*/
inline void SetAttributes(const Aws::Map<Aws::String, Aws::String>& value) { m_attributesHasBeenSet = true; m_attributes = value; }
/**
* <p>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.</p> <p>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.</p>
*/
inline void SetAttributes(Aws::Map<Aws::String, Aws::String>&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); }
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithAttributes(const Aws::Map<Aws::String, Aws::String>& value) { SetAttributes(value); return *this;}
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& WithAttributes(Aws::Map<Aws::String, Aws::String>&& value) { SetAttributes(std::move(value)); return *this;}
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; }
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; }
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; }
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; }
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& AddAttributes(const char* key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; }
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& AddAttributes(Aws::String&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; }
/**
* <p>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.</p> <p>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.</p>
*/
inline StartOutboundVoiceContactRequest& AddAttributes(const char* key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; }
private:
Aws::String m_destinationPhoneNumber;
bool m_destinationPhoneNumberHasBeenSet;
Aws::String m_contactFlowId;
bool m_contactFlowIdHasBeenSet;
Aws::String m_instanceId;
bool m_instanceIdHasBeenSet;
Aws::String m_clientToken;
bool m_clientTokenHasBeenSet;
Aws::String m_sourcePhoneNumber;
bool m_sourcePhoneNumberHasBeenSet;
Aws::String m_queueId;
bool m_queueIdHasBeenSet;
Aws::Map<Aws::String, Aws::String> m_attributes;
bool m_attributesHasBeenSet;
};
} // namespace Model
} // namespace Connect
} // namespace Aws