AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Connect::Model::StartOutboundVoiceContactRequest Class Reference

#include <StartOutboundVoiceContactRequest.h>

+ Inheritance diagram for Aws::Connect::Model::StartOutboundVoiceContactRequest:

Public Member Functions

 StartOutboundVoiceContactRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDestinationPhoneNumber () const
 
bool DestinationPhoneNumberHasBeenSet () const
 
void SetDestinationPhoneNumber (const Aws::String &value)
 
void SetDestinationPhoneNumber (Aws::String &&value)
 
void SetDestinationPhoneNumber (const char *value)
 
StartOutboundVoiceContactRequestWithDestinationPhoneNumber (const Aws::String &value)
 
StartOutboundVoiceContactRequestWithDestinationPhoneNumber (Aws::String &&value)
 
StartOutboundVoiceContactRequestWithDestinationPhoneNumber (const char *value)
 
const Aws::StringGetContactFlowId () const
 
bool ContactFlowIdHasBeenSet () const
 
void SetContactFlowId (const Aws::String &value)
 
void SetContactFlowId (Aws::String &&value)
 
void SetContactFlowId (const char *value)
 
StartOutboundVoiceContactRequestWithContactFlowId (const Aws::String &value)
 
StartOutboundVoiceContactRequestWithContactFlowId (Aws::String &&value)
 
StartOutboundVoiceContactRequestWithContactFlowId (const char *value)
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
StartOutboundVoiceContactRequestWithInstanceId (const Aws::String &value)
 
StartOutboundVoiceContactRequestWithInstanceId (Aws::String &&value)
 
StartOutboundVoiceContactRequestWithInstanceId (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
StartOutboundVoiceContactRequestWithClientToken (const Aws::String &value)
 
StartOutboundVoiceContactRequestWithClientToken (Aws::String &&value)
 
StartOutboundVoiceContactRequestWithClientToken (const char *value)
 
const Aws::StringGetSourcePhoneNumber () const
 
bool SourcePhoneNumberHasBeenSet () const
 
void SetSourcePhoneNumber (const Aws::String &value)
 
void SetSourcePhoneNumber (Aws::String &&value)
 
void SetSourcePhoneNumber (const char *value)
 
StartOutboundVoiceContactRequestWithSourcePhoneNumber (const Aws::String &value)
 
StartOutboundVoiceContactRequestWithSourcePhoneNumber (Aws::String &&value)
 
StartOutboundVoiceContactRequestWithSourcePhoneNumber (const char *value)
 
const Aws::StringGetQueueId () const
 
bool QueueIdHasBeenSet () const
 
void SetQueueId (const Aws::String &value)
 
void SetQueueId (Aws::String &&value)
 
void SetQueueId (const char *value)
 
StartOutboundVoiceContactRequestWithQueueId (const Aws::String &value)
 
StartOutboundVoiceContactRequestWithQueueId (Aws::String &&value)
 
StartOutboundVoiceContactRequestWithQueueId (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetAttributes () const
 
bool AttributesHasBeenSet () const
 
void SetAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
StartOutboundVoiceContactRequestWithAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
StartOutboundVoiceContactRequestWithAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
StartOutboundVoiceContactRequestAddAttributes (const Aws::String &key, const Aws::String &value)
 
StartOutboundVoiceContactRequestAddAttributes (Aws::String &&key, const Aws::String &value)
 
StartOutboundVoiceContactRequestAddAttributes (const Aws::String &key, Aws::String &&value)
 
StartOutboundVoiceContactRequestAddAttributes (Aws::String &&key, Aws::String &&value)
 
StartOutboundVoiceContactRequestAddAttributes (const char *key, Aws::String &&value)
 
StartOutboundVoiceContactRequestAddAttributes (Aws::String &&key, const char *value)
 
StartOutboundVoiceContactRequestAddAttributes (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::Connect::ConnectRequest
virtual ~ConnectRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Connect::ConnectRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file StartOutboundVoiceContactRequest.h.

Constructor & Destructor Documentation

◆ StartOutboundVoiceContactRequest()

Aws::Connect::Model::StartOutboundVoiceContactRequest::StartOutboundVoiceContactRequest ( )

Member Function Documentation

◆ AddAttributes() [1/7]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::AddAttributes ( const Aws::String key,
const Aws::String value 
)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 464 of file StartOutboundVoiceContactRequest.h.

◆ AddAttributes() [2/7]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::AddAttributes ( Aws::String &&  key,
const Aws::String value 
)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 473 of file StartOutboundVoiceContactRequest.h.

◆ AddAttributes() [3/7]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::AddAttributes ( const Aws::String key,
Aws::String &&  value 
)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 482 of file StartOutboundVoiceContactRequest.h.

◆ AddAttributes() [4/7]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::AddAttributes ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 491 of file StartOutboundVoiceContactRequest.h.

◆ AddAttributes() [5/7]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::AddAttributes ( const char *  key,
Aws::String &&  value 
)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 500 of file StartOutboundVoiceContactRequest.h.

◆ AddAttributes() [6/7]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::AddAttributes ( Aws::String &&  key,
const char *  value 
)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 509 of file StartOutboundVoiceContactRequest.h.

◆ AddAttributes() [7/7]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::AddAttributes ( const char *  key,
const char *  value 
)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 518 of file StartOutboundVoiceContactRequest.h.

◆ AttributesHasBeenSet()

bool Aws::Connect::Model::StartOutboundVoiceContactRequest::AttributesHasBeenSet ( ) const
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 419 of file StartOutboundVoiceContactRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::Connect::Model::StartOutboundVoiceContactRequest::ClientTokenHasBeenSet ( ) const
inline

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.

Definition at line 230 of file StartOutboundVoiceContactRequest.h.

◆ ContactFlowIdHasBeenSet()

bool Aws::Connect::Model::StartOutboundVoiceContactRequest::ContactFlowIdHasBeenSet ( ) const
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 100 of file StartOutboundVoiceContactRequest.h.

◆ DestinationPhoneNumberHasBeenSet()

bool Aws::Connect::Model::StartOutboundVoiceContactRequest::DestinationPhoneNumberHasBeenSet ( ) const
inline

The phone number of the customer, in E.164 format.

Definition at line 45 of file StartOutboundVoiceContactRequest.h.

◆ GetAttributes()

const Aws::Map<Aws::String, Aws::String>& Aws::Connect::Model::StartOutboundVoiceContactRequest::GetAttributes ( ) const
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 410 of file StartOutboundVoiceContactRequest.h.

◆ GetClientToken()

const Aws::String& Aws::Connect::Model::StartOutboundVoiceContactRequest::GetClientToken ( ) const
inline

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.

Definition at line 222 of file StartOutboundVoiceContactRequest.h.

◆ GetContactFlowId()

const Aws::String& Aws::Connect::Model::StartOutboundVoiceContactRequest::GetContactFlowId ( ) const
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 88 of file StartOutboundVoiceContactRequest.h.

◆ GetDestinationPhoneNumber()

const Aws::String& Aws::Connect::Model::StartOutboundVoiceContactRequest::GetDestinationPhoneNumber ( ) const
inline

The phone number of the customer, in E.164 format.

Definition at line 40 of file StartOutboundVoiceContactRequest.h.

◆ GetInstanceId()

const Aws::String& Aws::Connect::Model::StartOutboundVoiceContactRequest::GetInstanceId ( ) const
inline

The identifier of the Amazon Connect instance.

Definition at line 178 of file StartOutboundVoiceContactRequest.h.

◆ GetQueueId()

const Aws::String& Aws::Connect::Model::StartOutboundVoiceContactRequest::GetQueueId ( ) const
inline

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.

Definition at line 344 of file StartOutboundVoiceContactRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Connect::Model::StartOutboundVoiceContactRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file StartOutboundVoiceContactRequest.h.

◆ GetSourcePhoneNumber()

const Aws::String& Aws::Connect::Model::StartOutboundVoiceContactRequest::GetSourcePhoneNumber ( ) const
inline

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.

Definition at line 286 of file StartOutboundVoiceContactRequest.h.

◆ InstanceIdHasBeenSet()

bool Aws::Connect::Model::StartOutboundVoiceContactRequest::InstanceIdHasBeenSet ( ) const
inline

The identifier of the Amazon Connect instance.

Definition at line 183 of file StartOutboundVoiceContactRequest.h.

◆ QueueIdHasBeenSet()

bool Aws::Connect::Model::StartOutboundVoiceContactRequest::QueueIdHasBeenSet ( ) const
inline

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.

Definition at line 352 of file StartOutboundVoiceContactRequest.h.

◆ SerializePayload()

Aws::String Aws::Connect::Model::StartOutboundVoiceContactRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributes() [1/2]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 428 of file StartOutboundVoiceContactRequest.h.

◆ SetAttributes() [2/2]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 437 of file StartOutboundVoiceContactRequest.h.

◆ SetClientToken() [1/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetClientToken ( const Aws::String value)
inline

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.

Definition at line 238 of file StartOutboundVoiceContactRequest.h.

◆ SetClientToken() [2/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetClientToken ( Aws::String &&  value)
inline

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.

Definition at line 246 of file StartOutboundVoiceContactRequest.h.

◆ SetClientToken() [3/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetClientToken ( const char *  value)
inline

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.

Definition at line 254 of file StartOutboundVoiceContactRequest.h.

◆ SetContactFlowId() [1/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetContactFlowId ( const Aws::String value)
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 112 of file StartOutboundVoiceContactRequest.h.

◆ SetContactFlowId() [2/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetContactFlowId ( Aws::String &&  value)
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 124 of file StartOutboundVoiceContactRequest.h.

◆ SetContactFlowId() [3/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetContactFlowId ( const char *  value)
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 136 of file StartOutboundVoiceContactRequest.h.

◆ SetDestinationPhoneNumber() [1/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetDestinationPhoneNumber ( const Aws::String value)
inline

The phone number of the customer, in E.164 format.

Definition at line 50 of file StartOutboundVoiceContactRequest.h.

◆ SetDestinationPhoneNumber() [2/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetDestinationPhoneNumber ( Aws::String &&  value)
inline

The phone number of the customer, in E.164 format.

Definition at line 55 of file StartOutboundVoiceContactRequest.h.

◆ SetDestinationPhoneNumber() [3/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetDestinationPhoneNumber ( const char *  value)
inline

The phone number of the customer, in E.164 format.

Definition at line 60 of file StartOutboundVoiceContactRequest.h.

◆ SetInstanceId() [1/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetInstanceId ( const Aws::String value)
inline

The identifier of the Amazon Connect instance.

Definition at line 188 of file StartOutboundVoiceContactRequest.h.

◆ SetInstanceId() [2/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetInstanceId ( Aws::String &&  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 193 of file StartOutboundVoiceContactRequest.h.

◆ SetInstanceId() [3/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetInstanceId ( const char *  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 198 of file StartOutboundVoiceContactRequest.h.

◆ SetQueueId() [1/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetQueueId ( const Aws::String value)
inline

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.

Definition at line 360 of file StartOutboundVoiceContactRequest.h.

◆ SetQueueId() [2/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetQueueId ( Aws::String &&  value)
inline

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.

Definition at line 368 of file StartOutboundVoiceContactRequest.h.

◆ SetQueueId() [3/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetQueueId ( const char *  value)
inline

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.

Definition at line 376 of file StartOutboundVoiceContactRequest.h.

◆ SetSourcePhoneNumber() [1/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetSourcePhoneNumber ( const Aws::String value)
inline

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.

Definition at line 300 of file StartOutboundVoiceContactRequest.h.

◆ SetSourcePhoneNumber() [2/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetSourcePhoneNumber ( Aws::String &&  value)
inline

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.

Definition at line 307 of file StartOutboundVoiceContactRequest.h.

◆ SetSourcePhoneNumber() [3/3]

void Aws::Connect::Model::StartOutboundVoiceContactRequest::SetSourcePhoneNumber ( const char *  value)
inline

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.

Definition at line 314 of file StartOutboundVoiceContactRequest.h.

◆ SourcePhoneNumberHasBeenSet()

bool Aws::Connect::Model::StartOutboundVoiceContactRequest::SourcePhoneNumberHasBeenSet ( ) const
inline

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.

Definition at line 293 of file StartOutboundVoiceContactRequest.h.

◆ WithAttributes() [1/2]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 446 of file StartOutboundVoiceContactRequest.h.

◆ WithAttributes() [2/2]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Definition at line 455 of file StartOutboundVoiceContactRequest.h.

◆ WithClientToken() [1/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithClientToken ( const Aws::String value)
inline

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.

Definition at line 262 of file StartOutboundVoiceContactRequest.h.

◆ WithClientToken() [2/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithClientToken ( Aws::String &&  value)
inline

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.

Definition at line 270 of file StartOutboundVoiceContactRequest.h.

◆ WithClientToken() [3/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithClientToken ( const char *  value)
inline

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.

Definition at line 278 of file StartOutboundVoiceContactRequest.h.

◆ WithContactFlowId() [1/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithContactFlowId ( const Aws::String value)
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 148 of file StartOutboundVoiceContactRequest.h.

◆ WithContactFlowId() [2/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithContactFlowId ( Aws::String &&  value)
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 160 of file StartOutboundVoiceContactRequest.h.

◆ WithContactFlowId() [3/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithContactFlowId ( const char *  value)
inline

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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

Definition at line 172 of file StartOutboundVoiceContactRequest.h.

◆ WithDestinationPhoneNumber() [1/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithDestinationPhoneNumber ( const Aws::String value)
inline

The phone number of the customer, in E.164 format.

Definition at line 65 of file StartOutboundVoiceContactRequest.h.

◆ WithDestinationPhoneNumber() [2/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithDestinationPhoneNumber ( Aws::String &&  value)
inline

The phone number of the customer, in E.164 format.

Definition at line 70 of file StartOutboundVoiceContactRequest.h.

◆ WithDestinationPhoneNumber() [3/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithDestinationPhoneNumber ( const char *  value)
inline

The phone number of the customer, in E.164 format.

Definition at line 75 of file StartOutboundVoiceContactRequest.h.

◆ WithInstanceId() [1/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithInstanceId ( const Aws::String value)
inline

The identifier of the Amazon Connect instance.

Definition at line 203 of file StartOutboundVoiceContactRequest.h.

◆ WithInstanceId() [2/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithInstanceId ( Aws::String &&  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 208 of file StartOutboundVoiceContactRequest.h.

◆ WithInstanceId() [3/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithInstanceId ( const char *  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 213 of file StartOutboundVoiceContactRequest.h.

◆ WithQueueId() [1/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithQueueId ( const Aws::String value)
inline

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.

Definition at line 384 of file StartOutboundVoiceContactRequest.h.

◆ WithQueueId() [2/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithQueueId ( Aws::String &&  value)
inline

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.

Definition at line 392 of file StartOutboundVoiceContactRequest.h.

◆ WithQueueId() [3/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithQueueId ( const char *  value)
inline

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.

Definition at line 400 of file StartOutboundVoiceContactRequest.h.

◆ WithSourcePhoneNumber() [1/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithSourcePhoneNumber ( const Aws::String value)
inline

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.

Definition at line 321 of file StartOutboundVoiceContactRequest.h.

◆ WithSourcePhoneNumber() [2/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithSourcePhoneNumber ( Aws::String &&  value)
inline

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.

Definition at line 328 of file StartOutboundVoiceContactRequest.h.

◆ WithSourcePhoneNumber() [3/3]

StartOutboundVoiceContactRequest& Aws::Connect::Model::StartOutboundVoiceContactRequest::WithSourcePhoneNumber ( const char *  value)
inline

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.

Definition at line 335 of file StartOutboundVoiceContactRequest.h.


The documentation for this class was generated from the following file: