You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Connect::Types::StartOutboundVoiceContactRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartOutboundVoiceContactRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  destination_phone_number: "PhoneNumber", # required
  contact_flow_id: "ContactFlowId", # required
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
  source_phone_number: "PhoneNumber",
  queue_id: "QueueId",
  attributes: {
    "AttributeName" => "AttributeValue",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    A custom key-value pair using an attribute map.

#client_token ⇒ String

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.

Returns:

  • (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#contact_flow_id ⇒ String

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

Returns:

  • (String) —

    The identifier of the contact flow for the outbound call.

#destination_phone_number ⇒ String

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

Returns:

  • (String) —

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

#instance_id ⇒ String

The identifier of the Amazon Connect instance.

Returns:

  • (String) —

    The identifier of the Amazon Connect instance.

#queue_id ⇒ 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 contact flow is used. If you do not specify a queue, you must specify a source phone number.

Returns:

  • (String) —

    The queue for the call.

#source_phone_number ⇒ 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.

Returns:

  • (String) —

    The phone number associated with the Amazon Connect instance, in E.164 format.