@aws-sdk/client-connect 3.458.0 → 3.461.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +104 -0
- package/dist-cjs/Connect.js +26 -0
- package/dist-cjs/commands/AssociateAnalyticsDataSetCommand.js +51 -0
- package/dist-cjs/commands/AssociateFlowCommand.js +51 -0
- package/dist-cjs/commands/BatchAssociateAnalyticsDataSetCommand.js +51 -0
- package/dist-cjs/commands/BatchDisassociateAnalyticsDataSetCommand.js +51 -0
- package/dist-cjs/commands/DisassociateAnalyticsDataSetCommand.js +51 -0
- package/dist-cjs/commands/DisassociateFlowCommand.js +51 -0
- package/dist-cjs/commands/GetFlowAssociationCommand.js +51 -0
- package/dist-cjs/commands/ImportPhoneNumberCommand.js +51 -0
- package/dist-cjs/commands/ListAnalyticsDataAssociationsCommand.js +51 -0
- package/dist-cjs/commands/ListFlowAssociationsCommand.js +51 -0
- package/dist-cjs/commands/ListRealtimeContactAnalysisSegmentsV2Command.js +51 -0
- package/dist-cjs/commands/SendChatIntegrationEventCommand.js +51 -0
- package/dist-cjs/commands/StartWebRTCContactCommand.js +52 -0
- package/dist-cjs/commands/index.js +13 -0
- package/dist-cjs/models/models_0.js +11 -10
- package/dist-cjs/models/models_1.js +81 -51
- package/dist-cjs/models/models_2.js +72 -1
- package/dist-cjs/pagination/ListFlowAssociationsPaginator.js +29 -0
- package/dist-cjs/pagination/ListRealtimeContactAnalysisSegmentsV2Paginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1056 -31
- package/dist-es/Connect.js +26 -0
- package/dist-es/commands/AssociateAnalyticsDataSetCommand.js +47 -0
- package/dist-es/commands/AssociateFlowCommand.js +47 -0
- package/dist-es/commands/BatchAssociateAnalyticsDataSetCommand.js +47 -0
- package/dist-es/commands/BatchDisassociateAnalyticsDataSetCommand.js +47 -0
- package/dist-es/commands/DisassociateAnalyticsDataSetCommand.js +47 -0
- package/dist-es/commands/DisassociateFlowCommand.js +47 -0
- package/dist-es/commands/GetFlowAssociationCommand.js +47 -0
- package/dist-es/commands/ImportPhoneNumberCommand.js +47 -0
- package/dist-es/commands/ListAnalyticsDataAssociationsCommand.js +47 -0
- package/dist-es/commands/ListFlowAssociationsCommand.js +47 -0
- package/dist-es/commands/ListRealtimeContactAnalysisSegmentsV2Command.js +47 -0
- package/dist-es/commands/SendChatIntegrationEventCommand.js +47 -0
- package/dist-es/commands/StartWebRTCContactCommand.js +48 -0
- package/dist-es/commands/index.js +13 -0
- package/dist-es/models/models_0.js +9 -8
- package/dist-es/models/models_1.js +79 -47
- package/dist-es/models/models_2.js +65 -0
- package/dist-es/pagination/ListFlowAssociationsPaginator.js +25 -0
- package/dist-es/pagination/ListRealtimeContactAnalysisSegmentsV2Paginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +1019 -21
- package/dist-types/Connect.d.ts +91 -0
- package/dist-types/ConnectClient.d.ts +15 -2
- package/dist-types/commands/AssociateAnalyticsDataSetCommand.d.ts +95 -0
- package/dist-types/commands/AssociateFlowCommand.d.ts +92 -0
- package/dist-types/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +107 -0
- package/dist-types/commands/BatchDisassociateAnalyticsDataSetCommand.d.ts +102 -0
- package/dist-types/commands/CreateRuleCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +1 -3
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/DescribeQuickConnectCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRuleCommand.d.ts +2 -2
- package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTrafficDistributionGroupCommand.d.ts +1 -2
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateAnalyticsDataSetCommand.d.ts +89 -0
- package/dist-types/commands/DisassociateFlowCommand.d.ts +91 -0
- package/dist-types/commands/GetFlowAssociationCommand.d.ts +95 -0
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +100 -0
- package/dist-types/commands/ListAnalyticsDataAssociationsCommand.d.ts +101 -0
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +101 -0
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +2 -2
- package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +4 -2
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +185 -0
- package/dist-types/commands/ListRulesCommand.d.ts +2 -2
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +2 -2
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +125 -0
- package/dist-types/commands/StartChatContactCommand.d.ts +1 -1
- package/dist-types/commands/StartContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -1
- package/dist-types/commands/StartContactStreamingCommand.d.ts +1 -1
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +1 -1
- package/dist-types/commands/StartWebRTCContactCommand.d.ts +137 -0
- package/dist-types/commands/StopContactCommand.d.ts +1 -1
- package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -1
- package/dist-types/commands/StopContactStreamingCommand.d.ts +1 -1
- package/dist-types/commands/SubmitContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TransferContactCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactAttributesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -2
- package/dist-types/commands/index.d.ts +13 -0
- package/dist-types/models/models_0.d.ts +271 -381
- package/dist-types/models/models_1.d.ts +3355 -3077
- package/dist-types/models/models_2.d.ts +1427 -2
- package/dist-types/pagination/ListFlowAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRealtimeContactAnalysisSegmentsV2Paginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +117 -0
- package/dist-types/ts3.4/Connect.d.ts +233 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +78 -0
- package/dist-types/ts3.4/commands/AssociateAnalyticsDataSetCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/AssociateFlowCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/BatchDisassociateAnalyticsDataSetCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeQuickConnectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeRoutingProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeRuleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeSecurityProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTrafficDistributionGroupCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DisassociateAnalyticsDataSetCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DisassociateFlowCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetFlowAssociationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ImportPhoneNumberCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAnalyticsDataAssociationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListFlowAssociationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +42 -0
- package/dist-types/ts3.4/commands/SendChatIntegrationEventCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartContactStreamingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartWebRTCContactCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/StopContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactStreamingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SubmitContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SuspendContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TransferContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowContentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowModuleContentCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +13 -0
- package/dist-types/ts3.4/models/models_0.d.ts +69 -94
- package/dist-types/ts3.4/models/models_1.d.ts +388 -256
- package/dist-types/ts3.4/models/models_2.d.ts +334 -0
- package/dist-types/ts3.4/pagination/ListFlowAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRealtimeContactAnalysisSegmentsV2Paginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +156 -0
- package/package.json +12 -12
|
@@ -1,5 +1,1418 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
+
import { AgentAvailabilityTimer, AgentConfig, AgentStatusState, AllowedCapabilities, Application, ContactFlowModuleState, ContactFlowState, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, HoursOfOperationConfig, InstanceAttributeType, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, OutboundCallerConfig, QueueStatus, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, ViewInputContent, ViewStatus } from "./models_0";
|
|
4
|
+
import { ChatEvent, HierarchyGroupCondition, HoursOfOperationSearchFilter, ParticipantDetails, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, SignInConfig, StringCondition, TelephonyConfig, UserSearchFilter } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface ChatStreamingConfiguration {
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
* <p>The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used
|
|
13
|
+
* to publish real-time message streaming for chat conversations.</p>
|
|
14
|
+
*/
|
|
15
|
+
StreamingEndpointArn: string | undefined;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
* <p>Payload of chat properties to apply when starting a new contact.</p>
|
|
20
|
+
*/
|
|
21
|
+
export interface NewSessionDetails {
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
* <p> The supported chat message content types. Supported types are <code>text/plain</code>,
|
|
25
|
+
* <code>text/markdown</code>, <code>application/json</code>,
|
|
26
|
+
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
27
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
|
|
28
|
+
* <p>Content types must always contain <code> text/plain</code>. You can then put any other
|
|
29
|
+
* supported type in the list. For example, all the following lists are valid because they contain
|
|
30
|
+
* <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>, <code>
|
|
31
|
+
* [text/markdown, text/plain]</code>, <code>[text/plain, application/json,
|
|
32
|
+
* application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
33
|
+
*/
|
|
34
|
+
SupportedMessagingContentTypes?: string[];
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
* <p>The customer's details.</p>
|
|
38
|
+
*/
|
|
39
|
+
ParticipantDetails?: ParticipantDetails;
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
* <p> A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p>
|
|
43
|
+
* <p> There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute
|
|
44
|
+
* keys can include only alphanumeric, dash, and underscore characters. </p>
|
|
45
|
+
*/
|
|
46
|
+
Attributes?: Record<string, string>;
|
|
47
|
+
/**
|
|
48
|
+
* @public
|
|
49
|
+
* <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
|
|
50
|
+
*/
|
|
51
|
+
StreamingConfiguration?: ChatStreamingConfiguration;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export interface SendChatIntegrationEventRequest {
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
* <p>External identifier of chat customer participant, used in part to uniquely identify a chat.
|
|
60
|
+
* For SMS, this is the E164 phone number of the chat customer participant.</p>
|
|
61
|
+
*/
|
|
62
|
+
SourceId: string | undefined;
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
* <p>Chat system identifier, used in part to uniquely identify chat. This is associated with the
|
|
66
|
+
* Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone
|
|
67
|
+
* number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.</p>
|
|
68
|
+
*/
|
|
69
|
+
DestinationId: string | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* @public
|
|
72
|
+
* <p>Classification of a channel. This is used in part to uniquely identify chat. </p>
|
|
73
|
+
* <p>Valid value: <code>["connect:sms"]</code>
|
|
74
|
+
* </p>
|
|
75
|
+
*/
|
|
76
|
+
Subtype?: string;
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
* <p>Chat integration event payload</p>
|
|
80
|
+
*/
|
|
81
|
+
Event: ChatEvent | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* @public
|
|
84
|
+
* <p>Contact properties to apply when starting a new chat. If the integration event is handled
|
|
85
|
+
* with an existing chat, this is ignored.</p>
|
|
86
|
+
*/
|
|
87
|
+
NewSessionDetails?: NewSessionDetails;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export interface SendChatIntegrationEventResponse {
|
|
93
|
+
/**
|
|
94
|
+
* @public
|
|
95
|
+
* <p>Identifier of chat contact used to handle integration event. This may be null if the
|
|
96
|
+
* integration event is not valid without an already existing chat contact.</p>
|
|
97
|
+
*/
|
|
98
|
+
InitialContactId?: string;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
* <p>Whether handling the integration event resulted in creating a new chat or acting on existing
|
|
102
|
+
* chat.</p>
|
|
103
|
+
*/
|
|
104
|
+
NewChatCreated?: boolean;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* @public
|
|
108
|
+
* <p>A chat message.</p>
|
|
109
|
+
*/
|
|
110
|
+
export interface ChatMessage {
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
* <p>The type of the content. Supported types are <code>text/plain</code>,
|
|
114
|
+
* <code>text/markdown</code>, <code>application/json</code>, and
|
|
115
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
|
|
116
|
+
*/
|
|
117
|
+
ContentType: string | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* @public
|
|
120
|
+
* <p>The content of the chat message. </p>
|
|
121
|
+
* <ul>
|
|
122
|
+
* <li>
|
|
123
|
+
* <p>For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are
|
|
124
|
+
* Minimum of 1, Maximum of 1024. </p>
|
|
125
|
+
* </li>
|
|
126
|
+
* <li>
|
|
127
|
+
* <p>For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of
|
|
128
|
+
* 12000. </p>
|
|
129
|
+
* </li>
|
|
130
|
+
* <li>
|
|
131
|
+
* <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the
|
|
132
|
+
* Length Constraints are Minimum of 1, Maximum of 12288.</p>
|
|
133
|
+
* </li>
|
|
134
|
+
* </ul>
|
|
135
|
+
*/
|
|
136
|
+
Content: string | undefined;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* <p>Enable persistent chats. For more information about enabling persistent chat, and for
|
|
141
|
+
* example use cases and how to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>
|
|
142
|
+
*/
|
|
143
|
+
export interface PersistentChat {
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
* <p>The contactId that is used for rehydration depends on the rehydration type. RehydrationType
|
|
147
|
+
* is required for persistent chat. </p>
|
|
148
|
+
* <ul>
|
|
149
|
+
* <li>
|
|
150
|
+
* <p>
|
|
151
|
+
* <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past
|
|
152
|
+
* chat contact of the specified past ended chat session. To use this type, provide the
|
|
153
|
+
* <code>initialContactId</code> of the past ended chat session in the
|
|
154
|
+
* <code>sourceContactId</code> field. In this type, Amazon Connect determines the most
|
|
155
|
+
* recent chat contact on the specified chat session that has ended, and uses it to start a
|
|
156
|
+
* persistent chat. </p>
|
|
157
|
+
* </li>
|
|
158
|
+
* <li>
|
|
159
|
+
* <p>
|
|
160
|
+
* <code>FROM_SEGMENT</code>: Rehydrates a chat from the past chat contact that is specified
|
|
161
|
+
* in the <code>sourceContactId</code> field. </p>
|
|
162
|
+
* </li>
|
|
163
|
+
* </ul>
|
|
164
|
+
* <p>The actual contactId used for rehydration is provided in the response of this API. </p>
|
|
165
|
+
*/
|
|
166
|
+
RehydrationType?: RehydrationType;
|
|
167
|
+
/**
|
|
168
|
+
* @public
|
|
169
|
+
* <p>The contactId from which a persistent chat session must be started.</p>
|
|
170
|
+
*/
|
|
171
|
+
SourceContactId?: string;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* @public
|
|
175
|
+
* <p>A value for a segment attribute. This is structured as a map where the key is
|
|
176
|
+
* <code>valueString</code> and the value is a string.</p>
|
|
177
|
+
*/
|
|
178
|
+
export interface SegmentAttributeValue {
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
* <p>The value of a segment attribute.</p>
|
|
182
|
+
*/
|
|
183
|
+
ValueString?: string;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
export interface StartChatContactRequest {
|
|
189
|
+
/**
|
|
190
|
+
* @public
|
|
191
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
192
|
+
*/
|
|
193
|
+
InstanceId: string | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* @public
|
|
196
|
+
* <p>The identifier of the flow for initiating the chat.
|
|
197
|
+
* To
|
|
198
|
+
* see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the
|
|
199
|
+
* flow page, under the name of the flow, choose <b>Show additional flow
|
|
200
|
+
* information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
201
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
202
|
+
* </p>
|
|
203
|
+
*/
|
|
204
|
+
ContactFlowId: string | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* @public
|
|
207
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p>
|
|
208
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
209
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
210
|
+
*/
|
|
211
|
+
Attributes?: Record<string, string>;
|
|
212
|
+
/**
|
|
213
|
+
* @public
|
|
214
|
+
* <p>Information identifying the participant.</p>
|
|
215
|
+
*/
|
|
216
|
+
ParticipantDetails: ParticipantDetails | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* @public
|
|
219
|
+
* <p>The initial message to be sent to the newly created chat.</p>
|
|
220
|
+
*/
|
|
221
|
+
InitialMessage?: ChatMessage;
|
|
222
|
+
/**
|
|
223
|
+
* @public
|
|
224
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
225
|
+
* request. If not provided, the Amazon Web Services
|
|
226
|
+
* SDK populates this field. For more information about idempotency, see
|
|
227
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
228
|
+
*/
|
|
229
|
+
ClientToken?: string;
|
|
230
|
+
/**
|
|
231
|
+
* @public
|
|
232
|
+
* <p>The total duration of the newly started chat session. If not specified, the chat session
|
|
233
|
+
* duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
|
|
234
|
+
* configurable time is 10,080 minutes (7 days).</p>
|
|
235
|
+
*/
|
|
236
|
+
ChatDurationInMinutes?: number;
|
|
237
|
+
/**
|
|
238
|
+
* @public
|
|
239
|
+
* <p>The supported chat message content types. Supported types are <code>text/plain</code>,
|
|
240
|
+
* <code>text/markdown</code>, <code>application/json</code>,
|
|
241
|
+
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
242
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
|
|
243
|
+
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
244
|
+
* supported type in the list. For example, all the following lists are valid because they contain
|
|
245
|
+
* <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
|
|
246
|
+
* <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
|
|
247
|
+
* application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
248
|
+
* <note>
|
|
249
|
+
* <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
|
|
250
|
+
* use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
|
|
251
|
+
* view</a> flow block.</p>
|
|
252
|
+
* </note>
|
|
253
|
+
*/
|
|
254
|
+
SupportedMessagingContentTypes?: string[];
|
|
255
|
+
/**
|
|
256
|
+
* @public
|
|
257
|
+
* <p>Enable persistent chats. For more information about enabling persistent chat, and for
|
|
258
|
+
* example use cases and how to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>
|
|
259
|
+
*/
|
|
260
|
+
PersistentChat?: PersistentChat;
|
|
261
|
+
/**
|
|
262
|
+
* @public
|
|
263
|
+
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
264
|
+
* chat starting.</p>
|
|
265
|
+
* <note>
|
|
266
|
+
* <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
|
|
267
|
+
* </note>
|
|
268
|
+
*/
|
|
269
|
+
RelatedContactId?: string;
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
273
|
+
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
|
|
274
|
+
* flows.</p>
|
|
275
|
+
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
276
|
+
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
277
|
+
* <note>
|
|
278
|
+
* <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
|
|
279
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in the
|
|
280
|
+
* SupportedMessagingContentTypes field of this API in order to set <code>SegmentAttributes</code> as \{<code>
|
|
281
|
+
* "connect:Subtype": \{"valueString" : "connect:Guide" \}\}</code>.</p>
|
|
282
|
+
* </note>
|
|
283
|
+
*/
|
|
284
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue>;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* @public
|
|
288
|
+
*/
|
|
289
|
+
export interface StartChatContactResponse {
|
|
290
|
+
/**
|
|
291
|
+
* @public
|
|
292
|
+
* <p>The identifier of this contact within the Amazon Connect instance. </p>
|
|
293
|
+
*/
|
|
294
|
+
ContactId?: string;
|
|
295
|
+
/**
|
|
296
|
+
* @public
|
|
297
|
+
* <p>The identifier for a chat participant. The participantId for a chat participant is the same
|
|
298
|
+
* throughout the chat lifecycle.</p>
|
|
299
|
+
*/
|
|
300
|
+
ParticipantId?: string;
|
|
301
|
+
/**
|
|
302
|
+
* @public
|
|
303
|
+
* <p>The token used by the chat participant to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat
|
|
304
|
+
* participant.</p>
|
|
305
|
+
*/
|
|
306
|
+
ParticipantToken?: string;
|
|
307
|
+
/**
|
|
308
|
+
* @public
|
|
309
|
+
* <p>The contactId from which a persistent chat session is started. This field is populated only
|
|
310
|
+
* for persistent chats.</p>
|
|
311
|
+
*/
|
|
312
|
+
ContinuedFromContactId?: string;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
export interface StartContactEvaluationRequest {
|
|
318
|
+
/**
|
|
319
|
+
* @public
|
|
320
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
321
|
+
*/
|
|
322
|
+
InstanceId: string | undefined;
|
|
323
|
+
/**
|
|
324
|
+
* @public
|
|
325
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
326
|
+
*/
|
|
327
|
+
ContactId: string | undefined;
|
|
328
|
+
/**
|
|
329
|
+
* @public
|
|
330
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
331
|
+
*/
|
|
332
|
+
EvaluationFormId: string | undefined;
|
|
333
|
+
/**
|
|
334
|
+
* @public
|
|
335
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
336
|
+
* request. If not provided, the Amazon Web Services
|
|
337
|
+
* SDK populates this field. For more information about idempotency, see
|
|
338
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
339
|
+
*/
|
|
340
|
+
ClientToken?: string;
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
export interface StartContactEvaluationResponse {
|
|
346
|
+
/**
|
|
347
|
+
* @public
|
|
348
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
349
|
+
*/
|
|
350
|
+
EvaluationId: string | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* @public
|
|
353
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
354
|
+
*/
|
|
355
|
+
EvaluationArn: string | undefined;
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* @public
|
|
359
|
+
* @enum
|
|
360
|
+
*/
|
|
361
|
+
export declare const VoiceRecordingTrack: {
|
|
362
|
+
readonly ALL: "ALL";
|
|
363
|
+
readonly FROM_AGENT: "FROM_AGENT";
|
|
364
|
+
readonly TO_AGENT: "TO_AGENT";
|
|
365
|
+
};
|
|
366
|
+
/**
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
export type VoiceRecordingTrack = (typeof VoiceRecordingTrack)[keyof typeof VoiceRecordingTrack];
|
|
370
|
+
/**
|
|
371
|
+
* @public
|
|
372
|
+
* <p>Contains information about the recording configuration settings.</p>
|
|
373
|
+
*/
|
|
374
|
+
export interface VoiceRecordingConfiguration {
|
|
375
|
+
/**
|
|
376
|
+
* @public
|
|
377
|
+
* <p>Identifies which track is being recorded.</p>
|
|
378
|
+
*/
|
|
379
|
+
VoiceRecordingTrack?: VoiceRecordingTrack;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
export interface StartContactRecordingRequest {
|
|
385
|
+
/**
|
|
386
|
+
* @public
|
|
387
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
388
|
+
*/
|
|
389
|
+
InstanceId: string | undefined;
|
|
390
|
+
/**
|
|
391
|
+
* @public
|
|
392
|
+
* <p>The identifier of the contact.</p>
|
|
393
|
+
*/
|
|
394
|
+
ContactId: string | undefined;
|
|
395
|
+
/**
|
|
396
|
+
* @public
|
|
397
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
398
|
+
* first interaction with the contact center.</p>
|
|
399
|
+
*/
|
|
400
|
+
InitialContactId: string | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* @public
|
|
403
|
+
* <p>The person being recorded.</p>
|
|
404
|
+
*/
|
|
405
|
+
VoiceRecordingConfiguration: VoiceRecordingConfiguration | undefined;
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
export interface StartContactRecordingResponse {
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
export interface StartContactStreamingRequest {
|
|
416
|
+
/**
|
|
417
|
+
* @public
|
|
418
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
419
|
+
*/
|
|
420
|
+
InstanceId: string | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
424
|
+
* first interaction with the contact center.</p>
|
|
425
|
+
*/
|
|
426
|
+
ContactId: string | undefined;
|
|
427
|
+
/**
|
|
428
|
+
* @public
|
|
429
|
+
* <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
|
|
430
|
+
*/
|
|
431
|
+
ChatStreamingConfiguration: ChatStreamingConfiguration | undefined;
|
|
432
|
+
/**
|
|
433
|
+
* @public
|
|
434
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
435
|
+
* request. If not provided, the Amazon Web Services
|
|
436
|
+
* SDK populates this field. For more information about idempotency, see
|
|
437
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
438
|
+
*/
|
|
439
|
+
ClientToken?: string;
|
|
440
|
+
}
|
|
441
|
+
/**
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
export interface StartContactStreamingResponse {
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
* <p>The identifier of the streaming configuration enabled. </p>
|
|
448
|
+
*/
|
|
449
|
+
StreamingId: string | undefined;
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* @public
|
|
453
|
+
* <p>Outbound calls to the destination number are not allowed.</p>
|
|
454
|
+
*/
|
|
455
|
+
export declare class DestinationNotAllowedException extends __BaseException {
|
|
456
|
+
readonly name: "DestinationNotAllowedException";
|
|
457
|
+
readonly $fault: "client";
|
|
458
|
+
/**
|
|
459
|
+
* @public
|
|
460
|
+
* <p>The message about the outbound calls.</p>
|
|
461
|
+
*/
|
|
462
|
+
Message?: string;
|
|
463
|
+
/**
|
|
464
|
+
* @internal
|
|
465
|
+
*/
|
|
466
|
+
constructor(opts: __ExceptionOptionType<DestinationNotAllowedException, __BaseException>);
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* @public
|
|
470
|
+
* <p>The contact is not permitted.</p>
|
|
471
|
+
*/
|
|
472
|
+
export declare class OutboundContactNotPermittedException extends __BaseException {
|
|
473
|
+
readonly name: "OutboundContactNotPermittedException";
|
|
474
|
+
readonly $fault: "client";
|
|
475
|
+
/**
|
|
476
|
+
* @public
|
|
477
|
+
* <p>The message about the contact.</p>
|
|
478
|
+
*/
|
|
479
|
+
Message?: string;
|
|
480
|
+
/**
|
|
481
|
+
* @internal
|
|
482
|
+
*/
|
|
483
|
+
constructor(opts: __ExceptionOptionType<OutboundContactNotPermittedException, __BaseException>);
|
|
484
|
+
}
|
|
485
|
+
/**
|
|
486
|
+
* @public
|
|
487
|
+
* <p>Configuration of the answering machine detection.</p>
|
|
488
|
+
*/
|
|
489
|
+
export interface AnswerMachineDetectionConfig {
|
|
490
|
+
/**
|
|
491
|
+
* @public
|
|
492
|
+
* <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice
|
|
493
|
+
* call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>.
|
|
494
|
+
* </p>
|
|
495
|
+
*/
|
|
496
|
+
EnableAnswerMachineDetection?: boolean;
|
|
497
|
+
/**
|
|
498
|
+
* @public
|
|
499
|
+
* <p>Wait for the answering machine prompt.</p>
|
|
500
|
+
*/
|
|
501
|
+
AwaitAnswerMachinePrompt?: boolean;
|
|
502
|
+
}
|
|
503
|
+
/**
|
|
504
|
+
* @public
|
|
505
|
+
* @enum
|
|
506
|
+
*/
|
|
507
|
+
export declare const TrafficType: {
|
|
508
|
+
readonly CAMPAIGN: "CAMPAIGN";
|
|
509
|
+
readonly GENERAL: "GENERAL";
|
|
510
|
+
};
|
|
511
|
+
/**
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType];
|
|
515
|
+
/**
|
|
516
|
+
* @public
|
|
517
|
+
*/
|
|
518
|
+
export interface StartOutboundVoiceContactRequest {
|
|
519
|
+
/**
|
|
520
|
+
* @public
|
|
521
|
+
* <p>The phone number of the customer, in E.164 format.</p>
|
|
522
|
+
*/
|
|
523
|
+
DestinationPhoneNumber: string | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* @public
|
|
526
|
+
* <p>The
|
|
527
|
+
* identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the
|
|
528
|
+
* navigation menu go to <b>Routing</b>, <b>Contact
|
|
529
|
+
* Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
530
|
+
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
531
|
+
* part of the ARN, shown here in bold: </p>
|
|
532
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
533
|
+
* </p>
|
|
534
|
+
*/
|
|
535
|
+
ContactFlowId: string | undefined;
|
|
536
|
+
/**
|
|
537
|
+
* @public
|
|
538
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
539
|
+
*/
|
|
540
|
+
InstanceId: string | undefined;
|
|
541
|
+
/**
|
|
542
|
+
* @public
|
|
543
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
544
|
+
* request. If not provided, the Amazon Web Services
|
|
545
|
+
* SDK populates this field. For more information about idempotency, see
|
|
546
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started,
|
|
547
|
+
* the contact ID is returned.
|
|
548
|
+
* </p>
|
|
549
|
+
*/
|
|
550
|
+
ClientToken?: string;
|
|
551
|
+
/**
|
|
552
|
+
* @public
|
|
553
|
+
* <p>The phone number associated with the Amazon Connect instance, in E.164 format. If you do
|
|
554
|
+
* not specify a source phone number, you must specify a queue.</p>
|
|
555
|
+
*/
|
|
556
|
+
SourcePhoneNumber?: string;
|
|
557
|
+
/**
|
|
558
|
+
* @public
|
|
559
|
+
* <p>The queue for the call. If you specify a queue, the phone displayed for caller ID is the
|
|
560
|
+
* phone number specified in the queue. If you do not specify a queue, the queue defined in the flow
|
|
561
|
+
* is used. If you do not specify a queue, you must specify a source phone number.</p>
|
|
562
|
+
*/
|
|
563
|
+
QueueId?: string;
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
* <p>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.</p>
|
|
567
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
568
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
569
|
+
*/
|
|
570
|
+
Attributes?: Record<string, string>;
|
|
571
|
+
/**
|
|
572
|
+
* @public
|
|
573
|
+
* <p>Configuration of the answering machine detection for this outbound call. </p>
|
|
574
|
+
*/
|
|
575
|
+
AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig;
|
|
576
|
+
/**
|
|
577
|
+
* @public
|
|
578
|
+
* <p>The campaign identifier of the outbound communication.</p>
|
|
579
|
+
*/
|
|
580
|
+
CampaignId?: string;
|
|
581
|
+
/**
|
|
582
|
+
* @public
|
|
583
|
+
* <p>Denotes the class of traffic. Calls with different traffic types are handled differently by
|
|
584
|
+
* Amazon Connect. The default value is <code>GENERAL</code>. Use <code>CAMPAIGN</code> if
|
|
585
|
+
* <code>EnableAnswerMachineDetection</code> is set to <code>true</code>. For all other cases, use
|
|
586
|
+
* <code>GENERAL</code>. </p>
|
|
587
|
+
*/
|
|
588
|
+
TrafficType?: TrafficType;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* @public
|
|
592
|
+
*/
|
|
593
|
+
export interface StartOutboundVoiceContactResponse {
|
|
594
|
+
/**
|
|
595
|
+
* @public
|
|
596
|
+
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
597
|
+
*/
|
|
598
|
+
ContactId?: string;
|
|
599
|
+
}
|
|
600
|
+
/**
|
|
601
|
+
* @public
|
|
602
|
+
*/
|
|
603
|
+
export interface StartTaskContactRequest {
|
|
604
|
+
/**
|
|
605
|
+
* @public
|
|
606
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
607
|
+
*/
|
|
608
|
+
InstanceId: string | undefined;
|
|
609
|
+
/**
|
|
610
|
+
* @public
|
|
611
|
+
* <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined
|
|
612
|
+
* attributes to task contacts linked using the same <code>PreviousContactID</code> will affect
|
|
613
|
+
* every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>
|
|
614
|
+
*/
|
|
615
|
+
PreviousContactId?: string;
|
|
616
|
+
/**
|
|
617
|
+
* @public
|
|
618
|
+
* <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,
|
|
619
|
+
* on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
620
|
+
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
621
|
+
* part of the ARN, shown here in bold: </p>
|
|
622
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
623
|
+
* </p>
|
|
624
|
+
*/
|
|
625
|
+
ContactFlowId?: string;
|
|
626
|
+
/**
|
|
627
|
+
* @public
|
|
628
|
+
* <p>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.</p>
|
|
629
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
630
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
631
|
+
*/
|
|
632
|
+
Attributes?: Record<string, string>;
|
|
633
|
+
/**
|
|
634
|
+
* @public
|
|
635
|
+
* <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
636
|
+
*/
|
|
637
|
+
Name: string | undefined;
|
|
638
|
+
/**
|
|
639
|
+
* @public
|
|
640
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
641
|
+
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
642
|
+
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
|
|
643
|
+
* supported reference type during task creation.</p>
|
|
644
|
+
*/
|
|
645
|
+
References?: Record<string, Reference>;
|
|
646
|
+
/**
|
|
647
|
+
* @public
|
|
648
|
+
* <p>A description of the task that is shown to an agent in the Contact Control Panel
|
|
649
|
+
* (CCP).</p>
|
|
650
|
+
*/
|
|
651
|
+
Description?: string;
|
|
652
|
+
/**
|
|
653
|
+
* @public
|
|
654
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
655
|
+
* request. If not provided, the Amazon Web Services
|
|
656
|
+
* SDK populates this field. For more information about idempotency, see
|
|
657
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
658
|
+
*/
|
|
659
|
+
ClientToken?: string;
|
|
660
|
+
/**
|
|
661
|
+
* @public
|
|
662
|
+
* <p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>
|
|
663
|
+
*/
|
|
664
|
+
ScheduledTime?: Date;
|
|
665
|
+
/**
|
|
666
|
+
* @public
|
|
667
|
+
* <p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the
|
|
668
|
+
* <i>Amazon Connect Administrator Guide</i>. </p>
|
|
669
|
+
*/
|
|
670
|
+
TaskTemplateId?: string;
|
|
671
|
+
/**
|
|
672
|
+
* @public
|
|
673
|
+
* <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the
|
|
674
|
+
* flow that is defined on agent or queue quick connect. For more information about quick connects,
|
|
675
|
+
* see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
|
|
676
|
+
* connects</a>.</p>
|
|
677
|
+
*/
|
|
678
|
+
QuickConnectId?: string;
|
|
679
|
+
/**
|
|
680
|
+
* @public
|
|
681
|
+
* <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking
|
|
682
|
+
* tasks together by using <code>RelatedContactID</code> copies over contact attributes from the
|
|
683
|
+
* related task contact to the new task contact. All updates to user-defined attributes in the new
|
|
684
|
+
* task contact are limited to the individual contact ID, unlike what happens when tasks are linked
|
|
685
|
+
* by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can
|
|
686
|
+
* be linked by using <code>RelatedContactId</code>. </p>
|
|
687
|
+
*/
|
|
688
|
+
RelatedContactId?: string;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
export interface StartTaskContactResponse {
|
|
694
|
+
/**
|
|
695
|
+
* @public
|
|
696
|
+
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
697
|
+
*/
|
|
698
|
+
ContactId?: string;
|
|
699
|
+
}
|
|
700
|
+
/**
|
|
701
|
+
* @public
|
|
702
|
+
*/
|
|
703
|
+
export interface StartWebRTCContactRequest {
|
|
704
|
+
/**
|
|
705
|
+
* @public
|
|
706
|
+
* <p>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.</p>
|
|
707
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
708
|
+
* can include only alphanumeric, -, and _ characters.</p>
|
|
709
|
+
*/
|
|
710
|
+
Attributes?: Record<string, string>;
|
|
711
|
+
/**
|
|
712
|
+
* @public
|
|
713
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
714
|
+
* request. If not provided, the Amazon Web Services
|
|
715
|
+
* SDK populates this field. For more information about idempotency, see
|
|
716
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
717
|
+
* <p>The token is valid for 7 days after creation. If a contact is already started, the contact
|
|
718
|
+
* ID is returned.</p>
|
|
719
|
+
*/
|
|
720
|
+
ClientToken?: string;
|
|
721
|
+
/**
|
|
722
|
+
* @public
|
|
723
|
+
* <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the
|
|
724
|
+
* navigation menu go to <b>Routing</b>, <b>Contact
|
|
725
|
+
* Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
726
|
+
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
727
|
+
* part of the ARN, shown here in bold: </p>
|
|
728
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
729
|
+
* </p>
|
|
730
|
+
*/
|
|
731
|
+
ContactFlowId: string | undefined;
|
|
732
|
+
/**
|
|
733
|
+
* @public
|
|
734
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
735
|
+
*/
|
|
736
|
+
InstanceId: string | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* @public
|
|
739
|
+
* <p>Information about the video sharing capabilities of the participants (customer,
|
|
740
|
+
* agent).</p>
|
|
741
|
+
*/
|
|
742
|
+
AllowedCapabilities?: AllowedCapabilities;
|
|
743
|
+
/**
|
|
744
|
+
* @public
|
|
745
|
+
* <p>The customer's details.</p>
|
|
746
|
+
*/
|
|
747
|
+
ParticipantDetails: ParticipantDetails | undefined;
|
|
748
|
+
/**
|
|
749
|
+
* @public
|
|
750
|
+
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
751
|
+
* contact starting.</p>
|
|
752
|
+
*/
|
|
753
|
+
RelatedContactId?: string;
|
|
754
|
+
/**
|
|
755
|
+
* @public
|
|
756
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
757
|
+
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
758
|
+
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
|
|
759
|
+
* supported reference type during task creation.</p>
|
|
760
|
+
*/
|
|
761
|
+
References?: Record<string, Reference>;
|
|
762
|
+
/**
|
|
763
|
+
* @public
|
|
764
|
+
* <p>A description of the task that is shown to an agent in the Contact Control Panel
|
|
765
|
+
* (CCP).</p>
|
|
766
|
+
*/
|
|
767
|
+
Description?: string;
|
|
768
|
+
}
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
* <p>The attendee information, including attendee ID and join token.</p>
|
|
772
|
+
*/
|
|
773
|
+
export interface Attendee {
|
|
774
|
+
/**
|
|
775
|
+
* @public
|
|
776
|
+
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
777
|
+
*/
|
|
778
|
+
AttendeeId?: string;
|
|
779
|
+
/**
|
|
780
|
+
* @public
|
|
781
|
+
* <p>The join token used by the Amazon Chime SDK attendee.</p>
|
|
782
|
+
*/
|
|
783
|
+
JoinToken?: string;
|
|
784
|
+
}
|
|
785
|
+
/**
|
|
786
|
+
* @public
|
|
787
|
+
* <p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>
|
|
788
|
+
*/
|
|
789
|
+
export interface MediaPlacement {
|
|
790
|
+
/**
|
|
791
|
+
* @public
|
|
792
|
+
* <p>The audio host URL.</p>
|
|
793
|
+
*/
|
|
794
|
+
AudioHostUrl?: string;
|
|
795
|
+
/**
|
|
796
|
+
* @public
|
|
797
|
+
* <p>The audio fallback URL.</p>
|
|
798
|
+
*/
|
|
799
|
+
AudioFallbackUrl?: string;
|
|
800
|
+
/**
|
|
801
|
+
* @public
|
|
802
|
+
* <p>The signaling URL.</p>
|
|
803
|
+
*/
|
|
804
|
+
SignalingUrl?: string;
|
|
805
|
+
/**
|
|
806
|
+
* @public
|
|
807
|
+
* <p>The turn control URL.</p>
|
|
808
|
+
*/
|
|
809
|
+
TurnControlUrl?: string;
|
|
810
|
+
/**
|
|
811
|
+
* @public
|
|
812
|
+
* <p>The event ingestion URL to which you send client meeting events.</p>
|
|
813
|
+
*/
|
|
814
|
+
EventIngestionUrl?: string;
|
|
815
|
+
}
|
|
816
|
+
/**
|
|
817
|
+
* @public
|
|
818
|
+
* @enum
|
|
819
|
+
*/
|
|
820
|
+
export declare const MeetingFeatureStatus: {
|
|
821
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
822
|
+
readonly UNAVAILABLE: "UNAVAILABLE";
|
|
823
|
+
};
|
|
824
|
+
/**
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
|
|
828
|
+
/**
|
|
829
|
+
* @public
|
|
830
|
+
* <p>Has audio-specific configurations as the operating parameter for Echo Reduction.</p>
|
|
831
|
+
*/
|
|
832
|
+
export interface AudioFeatures {
|
|
833
|
+
/**
|
|
834
|
+
* @public
|
|
835
|
+
* <p>Makes echo reduction available to clients who connect to the meeting.</p>
|
|
836
|
+
*/
|
|
837
|
+
EchoReduction?: MeetingFeatureStatus;
|
|
838
|
+
}
|
|
839
|
+
/**
|
|
840
|
+
* @public
|
|
841
|
+
* <p>The configuration settings of the features available to a meeting.</p>
|
|
842
|
+
*/
|
|
843
|
+
export interface MeetingFeaturesConfiguration {
|
|
844
|
+
/**
|
|
845
|
+
* @public
|
|
846
|
+
* <p>The configuration settings for the audio features available to a meeting.</p>
|
|
847
|
+
*/
|
|
848
|
+
Audio?: AudioFeatures;
|
|
849
|
+
}
|
|
850
|
+
/**
|
|
851
|
+
* @public
|
|
852
|
+
* <p>A meeting created using the Amazon Chime SDK.</p>
|
|
853
|
+
*/
|
|
854
|
+
export interface Meeting {
|
|
855
|
+
/**
|
|
856
|
+
* @public
|
|
857
|
+
* <p>The Amazon Web Services Region in which you create the meeting.</p>
|
|
858
|
+
*/
|
|
859
|
+
MediaRegion?: string;
|
|
860
|
+
/**
|
|
861
|
+
* @public
|
|
862
|
+
* <p>The media placement for the meeting.</p>
|
|
863
|
+
*/
|
|
864
|
+
MediaPlacement?: MediaPlacement;
|
|
865
|
+
/**
|
|
866
|
+
* @public
|
|
867
|
+
* <p>The configuration settings of the features available to a meeting.</p>
|
|
868
|
+
*/
|
|
869
|
+
MeetingFeatures?: MeetingFeaturesConfiguration;
|
|
870
|
+
/**
|
|
871
|
+
* @public
|
|
872
|
+
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
873
|
+
*/
|
|
874
|
+
MeetingId?: string;
|
|
875
|
+
}
|
|
876
|
+
/**
|
|
877
|
+
* @public
|
|
878
|
+
* <p>Information required to join the call.</p>
|
|
879
|
+
*/
|
|
880
|
+
export interface ConnectionData {
|
|
881
|
+
/**
|
|
882
|
+
* @public
|
|
883
|
+
* <p>The attendee information, including attendee ID and join token.</p>
|
|
884
|
+
*/
|
|
885
|
+
Attendee?: Attendee;
|
|
886
|
+
/**
|
|
887
|
+
* @public
|
|
888
|
+
* <p>A meeting created using the Amazon Chime SDK.</p>
|
|
889
|
+
*/
|
|
890
|
+
Meeting?: Meeting;
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
export interface StartWebRTCContactResponse {
|
|
896
|
+
/**
|
|
897
|
+
* @public
|
|
898
|
+
* <p>Information required for the client application (mobile application or website) to connect
|
|
899
|
+
* to the call.</p>
|
|
900
|
+
*/
|
|
901
|
+
ConnectionData?: ConnectionData;
|
|
902
|
+
/**
|
|
903
|
+
* @public
|
|
904
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
905
|
+
*/
|
|
906
|
+
ContactId?: string;
|
|
907
|
+
/**
|
|
908
|
+
* @public
|
|
909
|
+
* <p>The identifier for a contact participant. The <code>ParticipantId</code> for a contact
|
|
910
|
+
* participant is the same throughout the contact lifecycle.</p>
|
|
911
|
+
*/
|
|
912
|
+
ParticipantId?: string;
|
|
913
|
+
/**
|
|
914
|
+
* @public
|
|
915
|
+
* <p>The token used by the contact participant to call the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API. The participant token is valid for the lifetime of a
|
|
916
|
+
* contact participant.</p>
|
|
917
|
+
*/
|
|
918
|
+
ParticipantToken?: string;
|
|
919
|
+
}
|
|
920
|
+
/**
|
|
921
|
+
* @public
|
|
922
|
+
* <p>The contact with the specified ID is not active or does not exist. Applies to Voice calls
|
|
923
|
+
* only, not to Chat or Task contacts.</p>
|
|
924
|
+
*/
|
|
925
|
+
export declare class ContactNotFoundException extends __BaseException {
|
|
926
|
+
readonly name: "ContactNotFoundException";
|
|
927
|
+
readonly $fault: "client";
|
|
928
|
+
/**
|
|
929
|
+
* @public
|
|
930
|
+
* <p>The message.</p>
|
|
931
|
+
*/
|
|
932
|
+
Message?: string;
|
|
933
|
+
/**
|
|
934
|
+
* @internal
|
|
935
|
+
*/
|
|
936
|
+
constructor(opts: __ExceptionOptionType<ContactNotFoundException, __BaseException>);
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* @public
|
|
940
|
+
* <p>Contains details about why a contact was disconnected. Only Amazon Connect outbound
|
|
941
|
+
* campaigns can provide this field.</p>
|
|
942
|
+
*/
|
|
943
|
+
export interface DisconnectReason {
|
|
944
|
+
/**
|
|
945
|
+
* @public
|
|
946
|
+
* <p>A code that indicates how the contact was terminated.</p>
|
|
947
|
+
*/
|
|
948
|
+
Code?: string;
|
|
949
|
+
}
|
|
950
|
+
/**
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
export interface StopContactRequest {
|
|
954
|
+
/**
|
|
955
|
+
* @public
|
|
956
|
+
* <p>The ID of the contact.</p>
|
|
957
|
+
*/
|
|
958
|
+
ContactId: string | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* @public
|
|
961
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
962
|
+
*/
|
|
963
|
+
InstanceId: string | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* @public
|
|
966
|
+
* <p>The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can
|
|
967
|
+
* provide this field.</p>
|
|
968
|
+
*/
|
|
969
|
+
DisconnectReason?: DisconnectReason;
|
|
970
|
+
}
|
|
971
|
+
/**
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
export interface StopContactResponse {
|
|
975
|
+
}
|
|
976
|
+
/**
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export interface StopContactRecordingRequest {
|
|
980
|
+
/**
|
|
981
|
+
* @public
|
|
982
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
983
|
+
*/
|
|
984
|
+
InstanceId: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* @public
|
|
987
|
+
* <p>The identifier of the contact.</p>
|
|
988
|
+
*/
|
|
989
|
+
ContactId: string | undefined;
|
|
990
|
+
/**
|
|
991
|
+
* @public
|
|
992
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
993
|
+
* first interaction with the contact center.</p>
|
|
994
|
+
*/
|
|
995
|
+
InitialContactId: string | undefined;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
export interface StopContactRecordingResponse {
|
|
1001
|
+
}
|
|
1002
|
+
/**
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
export interface StopContactStreamingRequest {
|
|
1006
|
+
/**
|
|
1007
|
+
* @public
|
|
1008
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1009
|
+
*/
|
|
1010
|
+
InstanceId: string | undefined;
|
|
1011
|
+
/**
|
|
1012
|
+
* @public
|
|
1013
|
+
* <p>The identifier of the contact. This is the identifier of the contact that is associated with
|
|
1014
|
+
* the first interaction with the contact center.</p>
|
|
1015
|
+
*/
|
|
1016
|
+
ContactId: string | undefined;
|
|
1017
|
+
/**
|
|
1018
|
+
* @public
|
|
1019
|
+
* <p>The identifier of the streaming configuration enabled. </p>
|
|
1020
|
+
*/
|
|
1021
|
+
StreamingId: string | undefined;
|
|
1022
|
+
}
|
|
1023
|
+
/**
|
|
1024
|
+
* @public
|
|
1025
|
+
*/
|
|
1026
|
+
export interface StopContactStreamingResponse {
|
|
1027
|
+
}
|
|
1028
|
+
/**
|
|
1029
|
+
* @public
|
|
1030
|
+
* <p>Information about input answers for a contact evaluation.</p>
|
|
1031
|
+
*/
|
|
1032
|
+
export interface EvaluationAnswerInput {
|
|
1033
|
+
/**
|
|
1034
|
+
* @public
|
|
1035
|
+
* <p>The value for an answer in a contact evaluation.</p>
|
|
1036
|
+
*/
|
|
1037
|
+
Value?: EvaluationAnswerData;
|
|
1038
|
+
}
|
|
1039
|
+
/**
|
|
1040
|
+
* @public
|
|
1041
|
+
*/
|
|
1042
|
+
export interface SubmitContactEvaluationRequest {
|
|
1043
|
+
/**
|
|
1044
|
+
* @public
|
|
1045
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1046
|
+
*/
|
|
1047
|
+
InstanceId: string | undefined;
|
|
1048
|
+
/**
|
|
1049
|
+
* @public
|
|
1050
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
1051
|
+
*/
|
|
1052
|
+
EvaluationId: string | undefined;
|
|
1053
|
+
/**
|
|
1054
|
+
* @public
|
|
1055
|
+
* <p>A map of question identifiers to answer value.</p>
|
|
1056
|
+
*/
|
|
1057
|
+
Answers?: Record<string, EvaluationAnswerInput>;
|
|
1058
|
+
/**
|
|
1059
|
+
* @public
|
|
1060
|
+
* <p>A map of question identifiers to note value.</p>
|
|
1061
|
+
*/
|
|
1062
|
+
Notes?: Record<string, EvaluationNote>;
|
|
1063
|
+
}
|
|
1064
|
+
/**
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
export interface SubmitContactEvaluationResponse {
|
|
1068
|
+
/**
|
|
1069
|
+
* @public
|
|
1070
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
1071
|
+
*/
|
|
1072
|
+
EvaluationId: string | undefined;
|
|
1073
|
+
/**
|
|
1074
|
+
* @public
|
|
1075
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
1076
|
+
*/
|
|
1077
|
+
EvaluationArn: string | undefined;
|
|
1078
|
+
}
|
|
1079
|
+
/**
|
|
1080
|
+
* @public
|
|
1081
|
+
*/
|
|
1082
|
+
export interface SuspendContactRecordingRequest {
|
|
1083
|
+
/**
|
|
1084
|
+
* @public
|
|
1085
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1086
|
+
*/
|
|
1087
|
+
InstanceId: string | undefined;
|
|
1088
|
+
/**
|
|
1089
|
+
* @public
|
|
1090
|
+
* <p>The identifier of the contact.</p>
|
|
1091
|
+
*/
|
|
1092
|
+
ContactId: string | undefined;
|
|
1093
|
+
/**
|
|
1094
|
+
* @public
|
|
1095
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
1096
|
+
* first interaction with the contact center.</p>
|
|
1097
|
+
*/
|
|
1098
|
+
InitialContactId: string | undefined;
|
|
1099
|
+
}
|
|
1100
|
+
/**
|
|
1101
|
+
* @public
|
|
1102
|
+
*/
|
|
1103
|
+
export interface SuspendContactRecordingResponse {
|
|
1104
|
+
}
|
|
1105
|
+
/**
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
1108
|
+
export interface TagResourceRequest {
|
|
1109
|
+
/**
|
|
1110
|
+
* @public
|
|
1111
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1112
|
+
*/
|
|
1113
|
+
resourceArn: string | undefined;
|
|
1114
|
+
/**
|
|
1115
|
+
* @public
|
|
1116
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
1117
|
+
*/
|
|
1118
|
+
tags: Record<string, string> | undefined;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* @public
|
|
1122
|
+
*/
|
|
1123
|
+
export interface TransferContactRequest {
|
|
1124
|
+
/**
|
|
1125
|
+
* @public
|
|
1126
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1127
|
+
*/
|
|
1128
|
+
InstanceId: string | undefined;
|
|
1129
|
+
/**
|
|
1130
|
+
* @public
|
|
1131
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1132
|
+
*/
|
|
1133
|
+
ContactId: string | undefined;
|
|
1134
|
+
/**
|
|
1135
|
+
* @public
|
|
1136
|
+
* <p>The identifier for the queue.</p>
|
|
1137
|
+
*/
|
|
1138
|
+
QueueId?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* @public
|
|
1141
|
+
* <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
|
|
1142
|
+
*/
|
|
1143
|
+
UserId?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* @public
|
|
1146
|
+
* <p>The identifier of the flow.</p>
|
|
1147
|
+
*/
|
|
1148
|
+
ContactFlowId: string | undefined;
|
|
1149
|
+
/**
|
|
1150
|
+
* @public
|
|
1151
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1152
|
+
* request. If not provided, the Amazon Web Services
|
|
1153
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1154
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1155
|
+
*/
|
|
1156
|
+
ClientToken?: string;
|
|
1157
|
+
}
|
|
1158
|
+
/**
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
export interface TransferContactResponse {
|
|
1162
|
+
/**
|
|
1163
|
+
* @public
|
|
1164
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1165
|
+
*/
|
|
1166
|
+
ContactId?: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* @public
|
|
1169
|
+
* <p>The Amazon Resource Name (ARN) of the contact.</p>
|
|
1170
|
+
*/
|
|
1171
|
+
ContactArn?: string;
|
|
1172
|
+
}
|
|
1173
|
+
/**
|
|
1174
|
+
* @public
|
|
1175
|
+
*/
|
|
1176
|
+
export interface UntagResourceRequest {
|
|
1177
|
+
/**
|
|
1178
|
+
* @public
|
|
1179
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1180
|
+
*/
|
|
1181
|
+
resourceArn: string | undefined;
|
|
1182
|
+
/**
|
|
1183
|
+
* @public
|
|
1184
|
+
* <p>The tag keys.</p>
|
|
1185
|
+
*/
|
|
1186
|
+
tagKeys: string[] | undefined;
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
export interface UpdateAgentStatusRequest {
|
|
1192
|
+
/**
|
|
1193
|
+
* @public
|
|
1194
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1195
|
+
*/
|
|
1196
|
+
InstanceId: string | undefined;
|
|
1197
|
+
/**
|
|
1198
|
+
* @public
|
|
1199
|
+
* <p>The identifier of the agent status.</p>
|
|
1200
|
+
*/
|
|
1201
|
+
AgentStatusId: string | undefined;
|
|
1202
|
+
/**
|
|
1203
|
+
* @public
|
|
1204
|
+
* <p>The name of the agent status.</p>
|
|
1205
|
+
*/
|
|
1206
|
+
Name?: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* @public
|
|
1209
|
+
* <p>The description of the agent status.</p>
|
|
1210
|
+
*/
|
|
1211
|
+
Description?: string;
|
|
1212
|
+
/**
|
|
1213
|
+
* @public
|
|
1214
|
+
* <p>The state of the agent status.</p>
|
|
1215
|
+
*/
|
|
1216
|
+
State?: AgentStatusState;
|
|
1217
|
+
/**
|
|
1218
|
+
* @public
|
|
1219
|
+
* <p>The display order of the agent status.</p>
|
|
1220
|
+
*/
|
|
1221
|
+
DisplayOrder?: number;
|
|
1222
|
+
/**
|
|
1223
|
+
* @public
|
|
1224
|
+
* <p>A number indicating the reset order of the agent status.</p>
|
|
1225
|
+
*/
|
|
1226
|
+
ResetOrderNumber?: boolean;
|
|
1227
|
+
}
|
|
1228
|
+
/**
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
export interface UpdateContactRequest {
|
|
1232
|
+
/**
|
|
1233
|
+
* @public
|
|
1234
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1235
|
+
*/
|
|
1236
|
+
InstanceId: string | undefined;
|
|
1237
|
+
/**
|
|
1238
|
+
* @public
|
|
1239
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
1240
|
+
* first interaction with your contact center.</p>
|
|
1241
|
+
*/
|
|
1242
|
+
ContactId: string | undefined;
|
|
1243
|
+
/**
|
|
1244
|
+
* @public
|
|
1245
|
+
* <p>The name of the contact.</p>
|
|
1246
|
+
*/
|
|
1247
|
+
Name?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* @public
|
|
1250
|
+
* <p>The description of the contact.</p>
|
|
1251
|
+
*/
|
|
1252
|
+
Description?: string;
|
|
1253
|
+
/**
|
|
1254
|
+
* @public
|
|
1255
|
+
* <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
|
|
1256
|
+
*/
|
|
1257
|
+
References?: Record<string, Reference>;
|
|
1258
|
+
}
|
|
1259
|
+
/**
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
export interface UpdateContactResponse {
|
|
1263
|
+
}
|
|
1264
|
+
/**
|
|
1265
|
+
* @public
|
|
1266
|
+
*/
|
|
1267
|
+
export interface UpdateContactAttributesRequest {
|
|
1268
|
+
/**
|
|
1269
|
+
* @public
|
|
1270
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
1271
|
+
* first interaction with the contact center.</p>
|
|
1272
|
+
*/
|
|
1273
|
+
InitialContactId: string | undefined;
|
|
1274
|
+
/**
|
|
1275
|
+
* @public
|
|
1276
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1277
|
+
*/
|
|
1278
|
+
InstanceId: string | undefined;
|
|
1279
|
+
/**
|
|
1280
|
+
* @public
|
|
1281
|
+
* <p>The Amazon Connect attributes. These attributes can be accessed in flows just like any
|
|
1282
|
+
* other contact attributes.</p>
|
|
1283
|
+
* <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys
|
|
1284
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
1285
|
+
*/
|
|
1286
|
+
Attributes: Record<string, string> | undefined;
|
|
1287
|
+
}
|
|
1288
|
+
/**
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
export interface UpdateContactAttributesResponse {
|
|
1292
|
+
}
|
|
1293
|
+
/**
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
export interface UpdateContactEvaluationRequest {
|
|
1297
|
+
/**
|
|
1298
|
+
* @public
|
|
1299
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1300
|
+
*/
|
|
1301
|
+
InstanceId: string | undefined;
|
|
1302
|
+
/**
|
|
1303
|
+
* @public
|
|
1304
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
1305
|
+
*/
|
|
1306
|
+
EvaluationId: string | undefined;
|
|
1307
|
+
/**
|
|
1308
|
+
* @public
|
|
1309
|
+
* <p>A map of question identifiers to answer value.</p>
|
|
1310
|
+
*/
|
|
1311
|
+
Answers?: Record<string, EvaluationAnswerInput>;
|
|
1312
|
+
/**
|
|
1313
|
+
* @public
|
|
1314
|
+
* <p>A map of question identifiers to note value.</p>
|
|
1315
|
+
*/
|
|
1316
|
+
Notes?: Record<string, EvaluationNote>;
|
|
1317
|
+
}
|
|
1318
|
+
/**
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
export interface UpdateContactEvaluationResponse {
|
|
1322
|
+
/**
|
|
1323
|
+
* @public
|
|
1324
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
1325
|
+
*/
|
|
1326
|
+
EvaluationId: string | undefined;
|
|
1327
|
+
/**
|
|
1328
|
+
* @public
|
|
1329
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
1330
|
+
*/
|
|
1331
|
+
EvaluationArn: string | undefined;
|
|
1332
|
+
}
|
|
1333
|
+
/**
|
|
1334
|
+
* @public
|
|
1335
|
+
*/
|
|
1336
|
+
export interface UpdateContactFlowContentRequest {
|
|
1337
|
+
/**
|
|
1338
|
+
* @public
|
|
1339
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
1340
|
+
*/
|
|
1341
|
+
InstanceId: string | undefined;
|
|
1342
|
+
/**
|
|
1343
|
+
* @public
|
|
1344
|
+
* <p>The identifier of the flow.</p>
|
|
1345
|
+
*/
|
|
1346
|
+
ContactFlowId: string | undefined;
|
|
1347
|
+
/**
|
|
1348
|
+
* @public
|
|
1349
|
+
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
1350
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
1351
|
+
* <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>
|
|
1352
|
+
*/
|
|
1353
|
+
Content: string | undefined;
|
|
1354
|
+
}
|
|
1355
|
+
/**
|
|
1356
|
+
* @public
|
|
1357
|
+
*/
|
|
1358
|
+
export interface UpdateContactFlowContentResponse {
|
|
1359
|
+
}
|
|
1360
|
+
/**
|
|
1361
|
+
* @public
|
|
1362
|
+
*/
|
|
1363
|
+
export interface UpdateContactFlowMetadataRequest {
|
|
1364
|
+
/**
|
|
1365
|
+
* @public
|
|
1366
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1367
|
+
*/
|
|
1368
|
+
InstanceId: string | undefined;
|
|
1369
|
+
/**
|
|
1370
|
+
* @public
|
|
1371
|
+
* <p>The identifier of the flow.</p>
|
|
1372
|
+
*/
|
|
1373
|
+
ContactFlowId: string | undefined;
|
|
1374
|
+
/**
|
|
1375
|
+
* @public
|
|
1376
|
+
* <p>The name of the flow.</p>
|
|
1377
|
+
*/
|
|
1378
|
+
Name?: string;
|
|
1379
|
+
/**
|
|
1380
|
+
* @public
|
|
1381
|
+
* <p>The description of the flow.</p>
|
|
1382
|
+
*/
|
|
1383
|
+
Description?: string;
|
|
1384
|
+
/**
|
|
1385
|
+
* @public
|
|
1386
|
+
* <p>The state of flow.</p>
|
|
1387
|
+
*/
|
|
1388
|
+
ContactFlowState?: ContactFlowState;
|
|
1389
|
+
}
|
|
1390
|
+
/**
|
|
1391
|
+
* @public
|
|
1392
|
+
*/
|
|
1393
|
+
export interface UpdateContactFlowMetadataResponse {
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* @public
|
|
1397
|
+
*/
|
|
1398
|
+
export interface UpdateContactFlowModuleContentRequest {
|
|
1399
|
+
/**
|
|
1400
|
+
* @public
|
|
1401
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1402
|
+
*/
|
|
1403
|
+
InstanceId: string | undefined;
|
|
1404
|
+
/**
|
|
1405
|
+
* @public
|
|
1406
|
+
* <p>The identifier of the flow module.</p>
|
|
1407
|
+
*/
|
|
1408
|
+
ContactFlowModuleId: string | undefined;
|
|
1409
|
+
/**
|
|
1410
|
+
* @public
|
|
1411
|
+
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
1412
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
1413
|
+
*/
|
|
1414
|
+
Content: string | undefined;
|
|
1415
|
+
}
|
|
3
1416
|
/**
|
|
4
1417
|
* @public
|
|
5
1418
|
*/
|
|
@@ -1988,6 +3401,18 @@ export interface SearchUsersRequest {
|
|
|
1988
3401
|
*/
|
|
1989
3402
|
SearchCriteria?: UserSearchCriteria;
|
|
1990
3403
|
}
|
|
3404
|
+
/**
|
|
3405
|
+
* @internal
|
|
3406
|
+
*/
|
|
3407
|
+
export declare const AttendeeFilterSensitiveLog: (obj: Attendee) => any;
|
|
3408
|
+
/**
|
|
3409
|
+
* @internal
|
|
3410
|
+
*/
|
|
3411
|
+
export declare const ConnectionDataFilterSensitiveLog: (obj: ConnectionData) => any;
|
|
3412
|
+
/**
|
|
3413
|
+
* @internal
|
|
3414
|
+
*/
|
|
3415
|
+
export declare const StartWebRTCContactResponseFilterSensitiveLog: (obj: StartWebRTCContactResponse) => any;
|
|
1991
3416
|
/**
|
|
1992
3417
|
* @internal
|
|
1993
3418
|
*/
|