Struct aws_sdk_connect::operation::start_outbound_voice_contact::StartOutboundVoiceContactInput

#[non_exhaustive]
pub struct StartOutboundVoiceContactInput {

    pub name: Option<String>,
    pub description: Option<String>,
    pub references: Option<HashMap<String, Reference>>,
    pub related_contact_id: Option<String>,
    pub destination_phone_number: Option<String>,
    pub contact_flow_id: Option<String>,
    pub instance_id: Option<String>,
    pub client_token: Option<String>,
    pub source_phone_number: Option<String>,
    pub queue_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub answer_machine_detection_config: Option<AnswerMachineDetectionConfig>,
    pub campaign_id: Option<String>,
    pub traffic_type: Option<TrafficType>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

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

description: Option<String>

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

references: 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.

related_contact_id: 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.

destination_phone_number: Option<String>

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

contact_flow_id: 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

instance_id: Option<String>

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

client_token: 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.

source_phone_number: 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.

queue_id: 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.

attributes: 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.

answer_machine_detection_config: Option<AnswerMachineDetectionConfig>

Configuration of the answering machine detection for this outbound call.

campaign_id: Option<String>

The campaign identifier of the outbound communication.

traffic_type: 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.

Implementations

impl StartOutboundVoiceContactInput

pub fn name(&self) -> Option<&str>

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

pub fn description(&self) -> Option<&str>

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

pub fn 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) -> Option<&str>

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) -> Option<&str>

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

pub fn contact_flow_id(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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) -> 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 ) -> Option<&AnswerMachineDetectionConfig>

Configuration of the answering machine detection for this outbound call.

pub fn campaign_id(&self) -> Option<&str>

The campaign identifier of the outbound communication.

pub fn 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.

impl StartOutboundVoiceContactInput

pub fn builder() -> StartOutboundVoiceContactInputBuilder

Creates a new builder-style object to manufacture StartOutboundVoiceContactInput.

Trait Implementations

impl Clone for StartOutboundVoiceContactInput

fn clone(&self) -> StartOutboundVoiceContactInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartOutboundVoiceContactInput

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

Formats the value using the given formatter.

impl PartialEq for StartOutboundVoiceContactInput

fn eq(&self, other: &StartOutboundVoiceContactInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartOutboundVoiceContactInput