class Aws::Connect::Types::StartChatContactRequest
@note When making an API call, you may pass StartChatContactRequest
data as a 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", }
@!attribute [rw] instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. @return [String]
@!attribute [rw] contact_flow_id
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** @return [String]
@!attribute [rw] attributes
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They 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. @return [Hash<String,String>]
@!attribute [rw] participant_details
Information identifying the participant. @return [Types::ParticipantDetails]
@!attribute [rw] initial_message
The initial message to be sent to the newly created chat. @return [Types::ChatMessage]
@!attribute [rw] client_token
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactRequest AWS API Documentation
Constants
- SENSITIVE