StartChatContactRequest

import type { StartChatContactRequest } from "https://aws-api.deno.dev/v0.3/services/connect.ts?docs=full";

interface StartChatContactRequest {

Attributes?: {

[key: string]: string | null | undefined;

} | null;

ClientToken?: string | null;

ContactFlowId: string;

InitialMessage?: ChatMessage | null;

InstanceId: string;

ParticipantDetails: ParticipantDetails;

}

§Properties

Attributes?: {

[key: string]: string | null | undefined;

} | null

[src]

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.

ClientToken?: string | null

[src]

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

ContactFlowId: string

[src]

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

InitialMessage?: ChatMessage | null

[src]

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

InstanceId: string

[src]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ParticipantDetails: ParticipantDetails

[src]

Information identifying the participant.