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

Class: Aws::Connect::Types::StartChatContactRequest

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

Overview

Note:

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

{
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  participant_details: { # required
    display_name: "DisplayName", # required
  },
  initial_message: {
    content_type: "ChatContentType", # required
    content: "ChatContent", # required
  },
  client_token: "ClientToken",
}

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.

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 initiating the chat. 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 initiating the chat.

#initial_message ⇒ Types::ChatMessage

The initial message to be sent to the newly created chat.

Returns:

#instance_id ⇒ String

The identifier of the Amazon Connect instance.

Returns:

  • (String) —

    The identifier of the Amazon Connect instance.

#participant_details ⇒ Types::ParticipantDetails

Information identifying the participant.

Returns: