Struct aws_sdk_connect::operation::start_outbound_voice_contact::builders::StartOutboundVoiceContactFluentBuilder

pub struct StartOutboundVoiceContactFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartOutboundVoiceContact.

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.

Implementations

impl StartOutboundVoiceContactFluentBuilder

pub fn as_input(&self) -> &StartOutboundVoiceContactInputBuilder

Access the StartOutboundVoiceContact as a reference.

pub async fn send( self ) -> Result<StartOutboundVoiceContactOutput, SdkError<StartOutboundVoiceContactError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<StartOutboundVoiceContactOutput, StartOutboundVoiceContactError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn name(self, input: impl Into<String>) -> Self

The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).

pub fn set_name(self, input: Option<String>) -> Self

The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).

pub fn get_name(&self) -> &Option<String>

The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).

pub fn description(self, input: impl Into<String>) -> Self

A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).

pub fn set_description(self, input: Option<String>) -> Self

A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).

pub fn get_description(&self) -> &Option<String>

A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).

pub fn references(self, k: impl Into<String>, v: Reference) -> Self

Adds a key-value pair to References.

To override the contents of this collection use set_references.

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.

pub fn set_references(self, input: Option<HashMap<String, Reference>>) -> Self

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.

pub fn get_references(&self) -> &Option<HashMap<String, Reference>>

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.

pub fn related_contact_id(self, input: impl Into<String>) -> Self

The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

pub fn set_related_contact_id(self, input: Option<String>) -> Self

The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

pub fn get_related_contact_id(&self) -> &Option<String>

The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

pub fn destination_phone_number(self, input: impl Into<String>) -> Self

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

pub fn set_destination_phone_number(self, input: Option<String>) -> Self

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

pub fn get_destination_phone_number(&self) -> &Option<String>

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

pub fn contact_flow_id(self, input: impl Into<String>) -> Self

The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

pub fn set_contact_flow_id(self, input: Option<String>) -> Self

The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

pub fn get_contact_flow_id(&self) -> &Option<String>

The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

pub fn instance_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn set_instance_id(self, input: Option<String>) -> Self

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn get_instance_id(&self) -> &Option<String>

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn client_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_token(self, input: Option<String>) -> Self

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.

pub fn get_client_token(&self) -> &Option<String>

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.

pub fn source_phone_number(self, input: impl Into<String>) -> Self

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.

pub fn set_source_phone_number(self, input: Option<String>) -> Self

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.

pub fn get_source_phone_number(&self) -> &Option<String>

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.

pub fn queue_id(self, input: impl Into<String>) -> Self

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.

pub fn set_queue_id(self, input: Option<String>) -> Self

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.

pub fn get_queue_id(&self) -> &Option<String>

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.

pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Attributes.

To override the contents of this collection use set_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.

pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn get_attributes(&self) -> &Option<HashMap<String, String>>

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.

pub fn answer_machine_detection_config( self, input: AnswerMachineDetectionConfig ) -> Self

Configuration of the answering machine detection for this outbound call.

pub fn set_answer_machine_detection_config( self, input: Option<AnswerMachineDetectionConfig> ) -> Self

Configuration of the answering machine detection for this outbound call.

pub fn get_answer_machine_detection_config( &self ) -> &Option<AnswerMachineDetectionConfig>

Configuration of the answering machine detection for this outbound call.

pub fn campaign_id(self, input: impl Into<String>) -> Self

The campaign identifier of the outbound communication.

pub fn set_campaign_id(self, input: Option<String>) -> Self

The campaign identifier of the outbound communication.

pub fn get_campaign_id(&self) -> &Option<String>

The campaign identifier of the outbound communication.

pub fn traffic_type(self, input: TrafficType) -> Self

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.

pub fn set_traffic_type(self, input: Option<TrafficType>) -> Self

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.

pub fn get_traffic_type(&self) -> &Option<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.

Trait Implementations

impl Clone for StartOutboundVoiceContactFluentBuilder

fn clone(&self) -> StartOutboundVoiceContactFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartOutboundVoiceContactFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.