@aws-sdk/client-connect 3.1076.0 → 3.1077.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 +14 -0
- package/dist-cjs/index.js +199 -53
- package/dist-es/Connect.js +4 -0
- package/dist-es/commands/CreateAttachedFileCommand.js +16 -0
- package/dist-es/commands/StartContactConversationalAnalyticsJobCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +25 -0
- package/dist-es/runtimeConfig.browser.js +0 -2
- package/dist-es/runtimeConfig.js +1 -2
- package/dist-es/runtimeConfig.native.js +0 -2
- package/dist-es/runtimeConfig.shared.js +2 -0
- package/dist-es/schemas/schemas_0.js +128 -50
- package/dist-types/Connect.d.ts +14 -0
- package/dist-types/ConnectClient.d.ts +4 -2
- package/dist-types/commands/BatchGetAttachedFileMetadataCommand.d.ts +1 -1
- package/dist-types/commands/CreateAttachedFileCommand.d.ts +115 -0
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/GetAttachedFileCommand.d.ts +1 -1
- package/dist-types/commands/GetMetricDataCommand.d.ts +2 -1
- package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -2
- package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +2 -1
- package/dist-types/commands/StartContactConversationalAnalyticsJobCommand.d.ts +135 -0
- package/dist-types/commands/StartEmailContactCommand.d.ts +2 -1
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +2 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactCommand.d.ts +2 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +65 -0
- package/dist-types/models/models_0.d.ts +75 -94
- package/dist-types/models/models_1.d.ts +95 -33
- package/dist-types/models/models_2.d.ts +34 -60
- package/dist-types/models/models_3.d.ts +218 -728
- package/dist-types/models/models_4.d.ts +728 -3
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +12 -0
- package/dist-types/ts3.4/Connect.d.ts +40 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CreateAttachedFileCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchEmailAddressesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartContactConversationalAnalyticsJobCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +30 -0
- package/dist-types/ts3.4/models/models_0.d.ts +14 -21
- package/dist-types/ts3.4/models/models_1.d.ts +22 -9
- package/dist-types/ts3.4/models/models_2.d.ts +9 -15
- package/dist-types/ts3.4/models/models_3.d.ts +56 -145
- package/dist-types/ts3.4/models/models_4.d.ts +155 -3
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
- package/package.json +6 -8
|
@@ -1,7 +1,64 @@
|
|
|
1
|
-
import type { AgentAvailabilityTimer, AgentStatusState, AttachmentScope, Channel, ChatEventType, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType,
|
|
2
|
-
import type { AfterContactWorkConfigPerChannel, AgentConfig, AgentStatusSearchFilter, AllowedCapabilities, Application, AutoAcceptConfig, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion,
|
|
3
|
-
import type { AttributeCondition, EvaluationAnswerData, EvaluationNote, Expiry, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase, WorkspaceTheme } from "./models_1";
|
|
1
|
+
import type { AgentAvailabilityTimer, AgentStatusState, AnalyticsMode, AttachmentScope, Behavior, Channel, ChatEventType, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, EmailHeaderType, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementOperator, EvaluationFormLanguageCode, EvaluationFormQuestionType, EvaluationFormVersionStatus, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InitiateAs, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MeetingFeatureStatus, NotificationPriority, NotificationStatus, OutboundMessageSourceType, OverrideType, ParticipantTimerAction, ParticipantTimerType, Policy, QueueStatus, RehydrationType, ResponseMode, RoutingCriteriaStepStatus, RulePublishStatus, SearchableQueueType, StringComparisonType, SummaryMode, TargetListType, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TimerEligibleParticipantRoles, TrafficType, ViewStatus, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
|
|
2
|
+
import type { AfterContactWorkConfigPerChannel, AgentConfig, AgentStatusSearchFilter, AliasConfiguration, AllowedCapabilities, Application, AutoAcceptConfig, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, EvaluationFormItemEnablementExpression, EvaluationFormQuestionScoringConfiguration, EvaluationFormQuestionTypeProperties, FlowModule, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OutboundStrategy, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttributeValues, PrimaryValue, QuickConnectConfig, RecurrenceConfig, Reference, RoutingProfileQueueConfig, RuleAction, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TestCaseEntryPoint, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, Validation, ViewInputContent, VoiceEnhancementConfig } from "./models_0";
|
|
3
|
+
import type { AttributeCondition, EvaluationAnswerData, EvaluationNote, Expiry, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase, View, WorkspaceTheme } from "./models_1";
|
|
4
4
|
import type { BooleanCondition, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, ControlPlaneTagFilter, DataTableSearchFilter, DateTimeCondition, DecimalCondition, EmailAddressSearchFilter, EvaluationSearchFilter, NumberCondition, SignInConfig, TelephonyConfig } from "./models_2";
|
|
5
|
+
/**
|
|
6
|
+
* <p>Contains information about an email address for a contact center.</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface EmailAddressMetadata {
|
|
10
|
+
/**
|
|
11
|
+
* <p>The identifier of the email address.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
EmailAddressId?: string | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>The Amazon Resource Name (ARN) of the email address.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
EmailAddressArn?: string | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* <p>The email address, including the domain.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
EmailAddress?: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>The description of the email address.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
Description?: string | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* <p>The display name of email address.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
DisplayName?: string | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* <p>A list of alias configurations for this email address, showing which email addresses forward to this primary
|
|
37
|
+
* address. Each configuration contains the email address ID of an alias that forwards emails to this address.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
AliasConfigurations?: AliasConfiguration[] | undefined;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
export interface SearchEmailAddressesResponse {
|
|
46
|
+
/**
|
|
47
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
NextToken?: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>List of email addresses matching SearchFilter and SearchCriteria </p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
EmailAddresses?: EmailAddressMetadata[] | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The total number of email addresses which matched your search query.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
ApproximateTotalCount?: number | undefined;
|
|
61
|
+
}
|
|
5
62
|
/**
|
|
6
63
|
* <p>Filters to be applied to search results.</p>
|
|
7
64
|
* @public
|
|
@@ -1895,6 +1952,164 @@ export interface StartChatContactResponse {
|
|
|
1895
1952
|
*/
|
|
1896
1953
|
ContinuedFromContactId?: string | undefined;
|
|
1897
1954
|
}
|
|
1955
|
+
/**
|
|
1956
|
+
* <p>The language configuration for conversational analytics.</p>
|
|
1957
|
+
* @public
|
|
1958
|
+
*/
|
|
1959
|
+
export interface LanguageConfiguration {
|
|
1960
|
+
/**
|
|
1961
|
+
* <p>The language locale setting for conversational analytics.</p>
|
|
1962
|
+
* @public
|
|
1963
|
+
*/
|
|
1964
|
+
LanguageLocale?: string | undefined;
|
|
1965
|
+
}
|
|
1966
|
+
/**
|
|
1967
|
+
* <p>The redaction configuration for conversational analytics.</p>
|
|
1968
|
+
* @public
|
|
1969
|
+
*/
|
|
1970
|
+
export interface RedactionConfiguration {
|
|
1971
|
+
/**
|
|
1972
|
+
* <p>Controls whether redaction is applied to the analytics output. Valid values: <code>Enable</code> |
|
|
1973
|
+
* <code>Disable</code>.</p>
|
|
1974
|
+
* @public
|
|
1975
|
+
*/
|
|
1976
|
+
Behavior: Behavior | undefined;
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>The redaction output policy that determines which versions of the transcript are stored. Valid values:
|
|
1979
|
+
* <code>None</code> | <code>RedactedOnly</code> | <code>RedactedAndOriginal</code>.</p>
|
|
1980
|
+
* @public
|
|
1981
|
+
*/
|
|
1982
|
+
Policy: Policy | undefined;
|
|
1983
|
+
/**
|
|
1984
|
+
* <p>The list of PII entity types to redact from the transcript (for example, <code>NAME</code>,
|
|
1985
|
+
* <code>ADDRESS</code>, <code>CREDIT_DEBIT_NUMBER</code>).</p>
|
|
1986
|
+
* @public
|
|
1987
|
+
*/
|
|
1988
|
+
Entities?: string[] | undefined;
|
|
1989
|
+
/**
|
|
1990
|
+
* <p>The masking mode that determines how redacted content is replaced in the output. Valid values:
|
|
1991
|
+
* <code>PII</code> (replaces with the literal string [PII]) | <code>EntityType</code> (replaces with the
|
|
1992
|
+
* entity type name, for example [NAME]).</p>
|
|
1993
|
+
* @public
|
|
1994
|
+
*/
|
|
1995
|
+
MaskMode?: MaskMode | undefined;
|
|
1996
|
+
}
|
|
1997
|
+
/**
|
|
1998
|
+
* <p>The rules configuration for conversational analytics. Controls whether Contact Lens rules are evaluated against
|
|
1999
|
+
* the analytics output.</p>
|
|
2000
|
+
* @public
|
|
2001
|
+
*/
|
|
2002
|
+
export interface RulesConfiguration {
|
|
2003
|
+
/**
|
|
2004
|
+
* <p>Controls whether Contact Lens rules are evaluated for the contact. Valid values: <code>Enable</code> |
|
|
2005
|
+
* <code>Disable</code>.</p>
|
|
2006
|
+
* @public
|
|
2007
|
+
*/
|
|
2008
|
+
Behavior?: Behavior | undefined;
|
|
2009
|
+
}
|
|
2010
|
+
/**
|
|
2011
|
+
* <p>The sentiment configuration for conversational analytics.</p>
|
|
2012
|
+
* @public
|
|
2013
|
+
*/
|
|
2014
|
+
export interface SentimentConfiguration {
|
|
2015
|
+
/**
|
|
2016
|
+
* <p>Controls whether sentiment analysis is applied to the analytics output. Valid values: <code>Enable</code> |
|
|
2017
|
+
* <code>Disable</code>.</p>
|
|
2018
|
+
* @public
|
|
2019
|
+
*/
|
|
2020
|
+
Behavior: Behavior | undefined;
|
|
2021
|
+
}
|
|
2022
|
+
/**
|
|
2023
|
+
* <p>The summary configuration for conversational analytics.</p>
|
|
2024
|
+
* @public
|
|
2025
|
+
*/
|
|
2026
|
+
export interface SummaryConfiguration {
|
|
2027
|
+
/**
|
|
2028
|
+
* <p>The summary modes that determine what type of summarization is generated. Valid values:
|
|
2029
|
+
* <code>PostContact</code> | <code>AutomatedInteraction</code> | <code>ContactChain</code>.</p>
|
|
2030
|
+
* @public
|
|
2031
|
+
*/
|
|
2032
|
+
SummaryModes: SummaryMode[] | undefined;
|
|
2033
|
+
}
|
|
2034
|
+
/**
|
|
2035
|
+
* <p>The configuration for conversational analytics.</p>
|
|
2036
|
+
* @public
|
|
2037
|
+
*/
|
|
2038
|
+
export interface AnalyticsConfiguration {
|
|
2039
|
+
/**
|
|
2040
|
+
* <p>The language configuration for conversational analytics.</p>
|
|
2041
|
+
* @public
|
|
2042
|
+
*/
|
|
2043
|
+
LanguageConfiguration: LanguageConfiguration | undefined;
|
|
2044
|
+
/**
|
|
2045
|
+
* <p>The redaction configuration for conversational analytics.</p>
|
|
2046
|
+
* @public
|
|
2047
|
+
*/
|
|
2048
|
+
RedactionConfiguration: RedactionConfiguration | undefined;
|
|
2049
|
+
/**
|
|
2050
|
+
* <p>The sentiment configuration for conversational analytics.</p>
|
|
2051
|
+
* @public
|
|
2052
|
+
*/
|
|
2053
|
+
SentimentConfiguration: SentimentConfiguration | undefined;
|
|
2054
|
+
/**
|
|
2055
|
+
* <p>The summary configuration for conversational analytics.</p>
|
|
2056
|
+
* @public
|
|
2057
|
+
*/
|
|
2058
|
+
SummaryConfiguration: SummaryConfiguration | undefined;
|
|
2059
|
+
/**
|
|
2060
|
+
* <p>The rules configuration for conversational analytics.</p>
|
|
2061
|
+
* @public
|
|
2062
|
+
*/
|
|
2063
|
+
RulesConfiguration: RulesConfiguration | undefined;
|
|
2064
|
+
}
|
|
2065
|
+
/**
|
|
2066
|
+
* @public
|
|
2067
|
+
*/
|
|
2068
|
+
export interface StartContactConversationalAnalyticsJobRequest {
|
|
2069
|
+
/**
|
|
2070
|
+
* <p>The identifier of the Connect Customer 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>
|
|
2071
|
+
* @public
|
|
2072
|
+
*/
|
|
2073
|
+
InstanceId: string | undefined;
|
|
2074
|
+
/**
|
|
2075
|
+
* <p>The identifier of the contact in this instance of Connect Customer. </p>
|
|
2076
|
+
* @public
|
|
2077
|
+
*/
|
|
2078
|
+
ContactId: string | undefined;
|
|
2079
|
+
/**
|
|
2080
|
+
* <p>The analytics modes to run for the contact. Valid values: <code>PostContact</code>.</p>
|
|
2081
|
+
* @public
|
|
2082
|
+
*/
|
|
2083
|
+
AnalyticsModes: AnalyticsMode[] | undefined;
|
|
2084
|
+
/**
|
|
2085
|
+
* <p>The configuration for the conversational analytics job.</p>
|
|
2086
|
+
* @public
|
|
2087
|
+
*/
|
|
2088
|
+
AnalyticsConfiguration: AnalyticsConfiguration | undefined;
|
|
2089
|
+
/**
|
|
2090
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2091
|
+
* request. If not provided, the Amazon Web Services
|
|
2092
|
+
* SDK populates this field. For more information about idempotency, see
|
|
2093
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2094
|
+
* @public
|
|
2095
|
+
*/
|
|
2096
|
+
ClientToken?: string | undefined;
|
|
2097
|
+
}
|
|
2098
|
+
/**
|
|
2099
|
+
* @public
|
|
2100
|
+
*/
|
|
2101
|
+
export interface StartContactConversationalAnalyticsJobResponse {
|
|
2102
|
+
/**
|
|
2103
|
+
* <p>The identifier of the Connect Customer instance.</p>
|
|
2104
|
+
* @public
|
|
2105
|
+
*/
|
|
2106
|
+
InstanceId?: string | undefined;
|
|
2107
|
+
/**
|
|
2108
|
+
* <p>The identifier of the contact.</p>
|
|
2109
|
+
* @public
|
|
2110
|
+
*/
|
|
2111
|
+
ContactId?: string | undefined;
|
|
2112
|
+
}
|
|
1898
2113
|
/**
|
|
1899
2114
|
* <p>Configuration information about automated evaluations.</p>
|
|
1900
2115
|
* @public
|
|
@@ -7157,728 +7372,3 @@ export interface CreateContactRequest {
|
|
|
7157
7372
|
*/
|
|
7158
7373
|
PreviousContactId?: string | undefined;
|
|
7159
7374
|
}
|
|
7160
|
-
/**
|
|
7161
|
-
* @public
|
|
7162
|
-
*/
|
|
7163
|
-
export interface StartChatContactRequest {
|
|
7164
|
-
/**
|
|
7165
|
-
* <p>The identifier of the Connect Customer 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>
|
|
7166
|
-
* @public
|
|
7167
|
-
*/
|
|
7168
|
-
InstanceId: string | undefined;
|
|
7169
|
-
/**
|
|
7170
|
-
* <p>The identifier of the flow for initiating the chat.
|
|
7171
|
-
* To
|
|
7172
|
-
* see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here
|
|
7173
|
-
* in bold: </p>
|
|
7174
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
7175
|
-
* </p>
|
|
7176
|
-
* @public
|
|
7177
|
-
*/
|
|
7178
|
-
ContactFlowId: string | undefined;
|
|
7179
|
-
/**
|
|
7180
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes. They
|
|
7181
|
-
* can be accessed in flows just like any other contact attributes. </p>
|
|
7182
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
7183
|
-
* alphanumeric, dash, and underscore characters.</p>
|
|
7184
|
-
* @public
|
|
7185
|
-
*/
|
|
7186
|
-
Attributes?: Record<string, string> | undefined;
|
|
7187
|
-
/**
|
|
7188
|
-
* <p>Information identifying the participant.</p>
|
|
7189
|
-
* @public
|
|
7190
|
-
*/
|
|
7191
|
-
ParticipantDetails: ParticipantDetails | undefined;
|
|
7192
|
-
/**
|
|
7193
|
-
* <p> The configuration of the participant. </p>
|
|
7194
|
-
* @public
|
|
7195
|
-
*/
|
|
7196
|
-
ParticipantConfiguration?: ParticipantConfiguration | undefined;
|
|
7197
|
-
/**
|
|
7198
|
-
* <p>The initial message to be sent to the newly created chat.</p>
|
|
7199
|
-
* @public
|
|
7200
|
-
*/
|
|
7201
|
-
InitialMessage?: ChatMessage | undefined;
|
|
7202
|
-
/**
|
|
7203
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
7204
|
-
* request. If not provided, the Amazon Web Services
|
|
7205
|
-
* SDK populates this field. For more information about idempotency, see
|
|
7206
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
7207
|
-
* @public
|
|
7208
|
-
*/
|
|
7209
|
-
ClientToken?: string | undefined;
|
|
7210
|
-
/**
|
|
7211
|
-
* <p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25
|
|
7212
|
-
* hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>
|
|
7213
|
-
* @public
|
|
7214
|
-
*/
|
|
7215
|
-
ChatDurationInMinutes?: number | undefined;
|
|
7216
|
-
/**
|
|
7217
|
-
* <p>The supported chat message content types. Supported types are <code>text/plain</code>,
|
|
7218
|
-
* <code>text/markdown</code>, <code>application/json</code>,
|
|
7219
|
-
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
7220
|
-
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
|
|
7221
|
-
* <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the
|
|
7222
|
-
* list. For example, all the following lists are valid because they contain <code>text/plain</code>: <code>[text/plain,
|
|
7223
|
-
* text/markdown, application/json]</code>, <code>[text/markdown, text/plain]</code>, <code>[text/plain,
|
|
7224
|
-
* application/json, application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
7225
|
-
* <note>
|
|
7226
|
-
* <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show view</a> flow block.</p>
|
|
7227
|
-
* </note>
|
|
7228
|
-
* @public
|
|
7229
|
-
*/
|
|
7230
|
-
SupportedMessagingContentTypes?: string[] | undefined;
|
|
7231
|
-
/**
|
|
7232
|
-
* <p>Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how
|
|
7233
|
-
* to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable
|
|
7234
|
-
* persistent chat</a>.</p>
|
|
7235
|
-
* @public
|
|
7236
|
-
*/
|
|
7237
|
-
PersistentChat?: PersistentChat | undefined;
|
|
7238
|
-
/**
|
|
7239
|
-
* <p>The unique identifier for an Connect Customer contact. This identifier is related to the chat starting.</p>
|
|
7240
|
-
* <note>
|
|
7241
|
-
* <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
|
|
7242
|
-
* </note>
|
|
7243
|
-
* @public
|
|
7244
|
-
*/
|
|
7245
|
-
RelatedContactId?: string | undefined;
|
|
7246
|
-
/**
|
|
7247
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
|
|
7248
|
-
* attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
|
|
7249
|
-
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
7250
|
-
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
7251
|
-
* <note>
|
|
7252
|
-
* <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
|
|
7253
|
-
* <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in the
|
|
7254
|
-
* SupportedMessagingContentTypes field of this API in order to set <code>SegmentAttributes</code> as \{<code>
|
|
7255
|
-
* "connect:Subtype": \{"valueString" : "connect:Guide" \}\}</code>.</p>
|
|
7256
|
-
* </note>
|
|
7257
|
-
* @public
|
|
7258
|
-
*/
|
|
7259
|
-
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
7260
|
-
/**
|
|
7261
|
-
* <p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from
|
|
7262
|
-
* your CRM.</p>
|
|
7263
|
-
* @public
|
|
7264
|
-
*/
|
|
7265
|
-
CustomerId?: string | undefined;
|
|
7266
|
-
/**
|
|
7267
|
-
* <p>A list of participant types to automatically disconnect when the end customer ends the chat session, allowing them to continue through disconnect flows such as surveys or feedback forms.</p>
|
|
7268
|
-
* @public
|
|
7269
|
-
*/
|
|
7270
|
-
DisconnectOnCustomerExit?: DisconnectOnCustomerExitParticipantType[] | undefined;
|
|
7271
|
-
}
|
|
7272
|
-
/**
|
|
7273
|
-
* @public
|
|
7274
|
-
*/
|
|
7275
|
-
export interface StartEmailContactRequest {
|
|
7276
|
-
/**
|
|
7277
|
-
* <p>The identifier of the Connect Customer 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>
|
|
7278
|
-
* @public
|
|
7279
|
-
*/
|
|
7280
|
-
InstanceId: string | undefined;
|
|
7281
|
-
/**
|
|
7282
|
-
* <p>The email address of the customer.</p>
|
|
7283
|
-
* @public
|
|
7284
|
-
*/
|
|
7285
|
-
FromEmailAddress: EmailAddressInfo | undefined;
|
|
7286
|
-
/**
|
|
7287
|
-
* <p>The email address associated with the Connect Customer instance.</p>
|
|
7288
|
-
* @public
|
|
7289
|
-
*/
|
|
7290
|
-
DestinationEmailAddress: string | undefined;
|
|
7291
|
-
/**
|
|
7292
|
-
* <p>A description of the email contact.</p>
|
|
7293
|
-
* @public
|
|
7294
|
-
*/
|
|
7295
|
-
Description?: string | undefined;
|
|
7296
|
-
/**
|
|
7297
|
-
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following
|
|
7298
|
-
* reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
|
|
7299
|
-
* <code>DATE</code>. <code>EMAIL</code> | <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported
|
|
7300
|
-
* reference type during email creation.</p>
|
|
7301
|
-
* @public
|
|
7302
|
-
*/
|
|
7303
|
-
References?: Record<string, Reference> | undefined;
|
|
7304
|
-
/**
|
|
7305
|
-
* <p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
7306
|
-
* @public
|
|
7307
|
-
*/
|
|
7308
|
-
Name?: string | undefined;
|
|
7309
|
-
/**
|
|
7310
|
-
* <p>The email message body to be sent to the newly created email.</p>
|
|
7311
|
-
* @public
|
|
7312
|
-
*/
|
|
7313
|
-
EmailMessage: InboundEmailContent | undefined;
|
|
7314
|
-
/**
|
|
7315
|
-
* <p>The additional recipients address of the email.</p>
|
|
7316
|
-
* @public
|
|
7317
|
-
*/
|
|
7318
|
-
AdditionalRecipients?: InboundAdditionalRecipients | undefined;
|
|
7319
|
-
/**
|
|
7320
|
-
* <p>List of S3 presigned URLs of email attachments and their file name. </p>
|
|
7321
|
-
* @public
|
|
7322
|
-
*/
|
|
7323
|
-
Attachments?: EmailAttachment[] | undefined;
|
|
7324
|
-
/**
|
|
7325
|
-
* <p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Connect Customer admin website, on the navigation
|
|
7326
|
-
* menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the
|
|
7327
|
-
* flow page, under the name of the flow, choose <b>Show additional flow information</b>. The
|
|
7328
|
-
* ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
7329
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
7330
|
-
* </p>
|
|
7331
|
-
* @public
|
|
7332
|
-
*/
|
|
7333
|
-
ContactFlowId?: string | undefined;
|
|
7334
|
-
/**
|
|
7335
|
-
* <p>The contactId that is related to this contact. Linking emails together by using <code>RelatedContactID</code>
|
|
7336
|
-
* copies over contact attributes from the related email contact to the new email contact. All updates to user-defined
|
|
7337
|
-
* attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of
|
|
7338
|
-
* contacts that can be linked by using <code>RelatedContactId</code>. </p>
|
|
7339
|
-
* @public
|
|
7340
|
-
*/
|
|
7341
|
-
RelatedContactId?: string | undefined;
|
|
7342
|
-
/**
|
|
7343
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and
|
|
7344
|
-
* can be accessed in flows just like any other contact attributes.</p>
|
|
7345
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
7346
|
-
* alphanumeric, dash, and underscore characters.</p>
|
|
7347
|
-
* @public
|
|
7348
|
-
*/
|
|
7349
|
-
Attributes?: Record<string, string> | undefined;
|
|
7350
|
-
/**
|
|
7351
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
|
|
7352
|
-
* attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
|
|
7353
|
-
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
7354
|
-
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
7355
|
-
* <note>
|
|
7356
|
-
* <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer number of minutes the
|
|
7357
|
-
* contact will be active for before expiring, with <code>SegmentAttributes</code> like \{ <code>
|
|
7358
|
-
* "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
|
|
7359
|
-
* </note>
|
|
7360
|
-
* @public
|
|
7361
|
-
*/
|
|
7362
|
-
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
7363
|
-
/**
|
|
7364
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
7365
|
-
* request. If not provided, the Amazon Web Services
|
|
7366
|
-
* SDK populates this field. For more information about idempotency, see
|
|
7367
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
7368
|
-
* @public
|
|
7369
|
-
*/
|
|
7370
|
-
ClientToken?: string | undefined;
|
|
7371
|
-
}
|
|
7372
|
-
/**
|
|
7373
|
-
* @public
|
|
7374
|
-
*/
|
|
7375
|
-
export interface StartOutboundChatContactRequest {
|
|
7376
|
-
/**
|
|
7377
|
-
* <p>Information about the endpoint.</p>
|
|
7378
|
-
* @public
|
|
7379
|
-
*/
|
|
7380
|
-
SourceEndpoint: Endpoint | undefined;
|
|
7381
|
-
/**
|
|
7382
|
-
* <p>Information about the endpoint.</p>
|
|
7383
|
-
* @public
|
|
7384
|
-
*/
|
|
7385
|
-
DestinationEndpoint: Endpoint | undefined;
|
|
7386
|
-
/**
|
|
7387
|
-
* <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name
|
|
7388
|
-
* (ARN) of the instance.</p>
|
|
7389
|
-
* @public
|
|
7390
|
-
*/
|
|
7391
|
-
InstanceId: string | undefined;
|
|
7392
|
-
/**
|
|
7393
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
|
|
7394
|
-
* attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
|
|
7395
|
-
* <ul>
|
|
7396
|
-
* <li>
|
|
7397
|
-
* <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
|
|
7398
|
-
* </li>
|
|
7399
|
-
* <li>
|
|
7400
|
-
* <p>This field can be used to show channel subtype, such as <code>connect:SMS</code> and
|
|
7401
|
-
* <code>connect:WhatsApp</code>.</p>
|
|
7402
|
-
* </li>
|
|
7403
|
-
* </ul>
|
|
7404
|
-
* @public
|
|
7405
|
-
*/
|
|
7406
|
-
SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
|
|
7407
|
-
/**
|
|
7408
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and
|
|
7409
|
-
* can be accessed in flows just like any other contact attributes.</p>
|
|
7410
|
-
* @public
|
|
7411
|
-
*/
|
|
7412
|
-
Attributes?: Record<string, string> | undefined;
|
|
7413
|
-
/**
|
|
7414
|
-
* <p>The identifier of the flow for the call. To see the ContactFlowId in the Connect Customer console user
|
|
7415
|
-
* interface, on the navigation menu go to <b>Routing, Contact Flows</b>. Choose the flow. On
|
|
7416
|
-
* the flow page, under the name of the flow, choose <b>Show additional flow information</b>.
|
|
7417
|
-
* The ContactFlowId is the last part of the ARN, shown here in bold:</p>
|
|
7418
|
-
* <ul>
|
|
7419
|
-
* <li>
|
|
7420
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
|
|
7421
|
-
* </p>
|
|
7422
|
-
* </li>
|
|
7423
|
-
* </ul>
|
|
7424
|
-
* @public
|
|
7425
|
-
*/
|
|
7426
|
-
ContactFlowId: string | undefined;
|
|
7427
|
-
/**
|
|
7428
|
-
* <p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25
|
|
7429
|
-
* hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>
|
|
7430
|
-
* @public
|
|
7431
|
-
*/
|
|
7432
|
-
ChatDurationInMinutes?: number | undefined;
|
|
7433
|
-
/**
|
|
7434
|
-
* <p>The customer's details.</p>
|
|
7435
|
-
* @public
|
|
7436
|
-
*/
|
|
7437
|
-
ParticipantDetails?: ParticipantDetails | undefined;
|
|
7438
|
-
/**
|
|
7439
|
-
* <p>A chat message.</p>
|
|
7440
|
-
* @public
|
|
7441
|
-
*/
|
|
7442
|
-
InitialSystemMessage?: ChatMessage | undefined;
|
|
7443
|
-
/**
|
|
7444
|
-
* <p>Information about template message configuration.</p>
|
|
7445
|
-
* @public
|
|
7446
|
-
*/
|
|
7447
|
-
InitialTemplatedSystemMessage?: TemplatedMessageConfig | undefined;
|
|
7448
|
-
/**
|
|
7449
|
-
* <p>The unique identifier for an Connect Customer contact. This identifier is related to the contact
|
|
7450
|
-
* starting.</p>
|
|
7451
|
-
* @public
|
|
7452
|
-
*/
|
|
7453
|
-
RelatedContactId?: string | undefined;
|
|
7454
|
-
/**
|
|
7455
|
-
* <p>The supported chat message content types. Supported types are:</p>
|
|
7456
|
-
* <ul>
|
|
7457
|
-
* <li>
|
|
7458
|
-
* <p>
|
|
7459
|
-
* <code>text/plain</code>
|
|
7460
|
-
* </p>
|
|
7461
|
-
* </li>
|
|
7462
|
-
* <li>
|
|
7463
|
-
* <p>
|
|
7464
|
-
* <code>text/markdown</code>
|
|
7465
|
-
* </p>
|
|
7466
|
-
* </li>
|
|
7467
|
-
* <li>
|
|
7468
|
-
* <p>
|
|
7469
|
-
* <code>application/json, application/vnd.amazonaws.connect.message.interactive</code>
|
|
7470
|
-
* </p>
|
|
7471
|
-
* </li>
|
|
7472
|
-
* <li>
|
|
7473
|
-
* <p>
|
|
7474
|
-
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>
|
|
7475
|
-
* </p>
|
|
7476
|
-
* </li>
|
|
7477
|
-
* </ul>
|
|
7478
|
-
* <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the
|
|
7479
|
-
* list. For example, all the following lists are valid because they contain <code>text/plain</code>:</p>
|
|
7480
|
-
* <ul>
|
|
7481
|
-
* <li>
|
|
7482
|
-
* <p>
|
|
7483
|
-
* <code>[text/plain, text/markdown, application/json]</code>
|
|
7484
|
-
* </p>
|
|
7485
|
-
* </li>
|
|
7486
|
-
* <li>
|
|
7487
|
-
* <p>
|
|
7488
|
-
* <code>[text/markdown, text/plain]</code>
|
|
7489
|
-
* </p>
|
|
7490
|
-
* </li>
|
|
7491
|
-
* <li>
|
|
7492
|
-
* <p>
|
|
7493
|
-
* <code>[text/plain, application/json,
|
|
7494
|
-
* application/vnd.amazonaws.connect.message.interactive.response]</code>
|
|
7495
|
-
* </p>
|
|
7496
|
-
* </li>
|
|
7497
|
-
* </ul>
|
|
7498
|
-
* @public
|
|
7499
|
-
*/
|
|
7500
|
-
SupportedMessagingContentTypes?: string[] | undefined;
|
|
7501
|
-
/**
|
|
7502
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
|
|
7503
|
-
* the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with
|
|
7504
|
-
* idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact
|
|
7505
|
-
* ID is returned.</p>
|
|
7506
|
-
* @public
|
|
7507
|
-
*/
|
|
7508
|
-
ClientToken?: string | undefined;
|
|
7509
|
-
}
|
|
7510
|
-
/**
|
|
7511
|
-
* @public
|
|
7512
|
-
*/
|
|
7513
|
-
export interface StartTaskContactRequest {
|
|
7514
|
-
/**
|
|
7515
|
-
* <p>The identifier of the Connect Customer 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>
|
|
7516
|
-
* @public
|
|
7517
|
-
*/
|
|
7518
|
-
InstanceId: string | undefined;
|
|
7519
|
-
/**
|
|
7520
|
-
* <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task
|
|
7521
|
-
* contacts linked using the same <code>PreviousContactID</code> will affect every contact in the chain. There can be a
|
|
7522
|
-
* maximum of 12 linked task contacts in a chain.</p>
|
|
7523
|
-
* @public
|
|
7524
|
-
*/
|
|
7525
|
-
PreviousContactId?: string | undefined;
|
|
7526
|
-
/**
|
|
7527
|
-
* <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Connect Customer admin website, on the navigation
|
|
7528
|
-
* menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the
|
|
7529
|
-
* flow page, under the name of the flow, choose <b>Show additional flow information</b>. The
|
|
7530
|
-
* ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
7531
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
7532
|
-
* </p>
|
|
7533
|
-
* @public
|
|
7534
|
-
*/
|
|
7535
|
-
ContactFlowId?: string | undefined;
|
|
7536
|
-
/**
|
|
7537
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and
|
|
7538
|
-
* can be accessed in flows just like any other contact attributes.</p>
|
|
7539
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
7540
|
-
* alphanumeric, dash, and underscore characters.</p>
|
|
7541
|
-
* @public
|
|
7542
|
-
*/
|
|
7543
|
-
Attributes?: Record<string, string> | undefined;
|
|
7544
|
-
/**
|
|
7545
|
-
* <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
7546
|
-
* @public
|
|
7547
|
-
*/
|
|
7548
|
-
Name: string | undefined;
|
|
7549
|
-
/**
|
|
7550
|
-
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
|
|
7551
|
-
* reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
|
|
7552
|
-
* <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during task
|
|
7553
|
-
* creation.</p>
|
|
7554
|
-
* @public
|
|
7555
|
-
*/
|
|
7556
|
-
References?: Record<string, Reference> | undefined;
|
|
7557
|
-
/**
|
|
7558
|
-
* <p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
7559
|
-
* @public
|
|
7560
|
-
*/
|
|
7561
|
-
Description?: string | undefined;
|
|
7562
|
-
/**
|
|
7563
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
7564
|
-
* request. If not provided, the Amazon Web Services
|
|
7565
|
-
* SDK populates this field. For more information about idempotency, see
|
|
7566
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
7567
|
-
* @public
|
|
7568
|
-
*/
|
|
7569
|
-
ClientToken?: string | undefined;
|
|
7570
|
-
/**
|
|
7571
|
-
* <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>
|
|
7572
|
-
* @public
|
|
7573
|
-
*/
|
|
7574
|
-
ScheduledTime?: Date | undefined;
|
|
7575
|
-
/**
|
|
7576
|
-
* <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 <i>Connect Customer Administrator Guide</i>. </p>
|
|
7577
|
-
* @public
|
|
7578
|
-
*/
|
|
7579
|
-
TaskTemplateId?: string | undefined;
|
|
7580
|
-
/**
|
|
7581
|
-
* <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the flow that is defined
|
|
7582
|
-
* on agent or queue quick connect. For more information about quick connects, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick connects</a>.</p>
|
|
7583
|
-
* @public
|
|
7584
|
-
*/
|
|
7585
|
-
QuickConnectId?: string | undefined;
|
|
7586
|
-
/**
|
|
7587
|
-
* <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 tasks together by using <code>RelatedContactID</code> copies over contact
|
|
7588
|
-
* attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new
|
|
7589
|
-
* task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using
|
|
7590
|
-
* <code>PreviousContactID</code>. There are no limits to the number of contacts that can be linked by using
|
|
7591
|
-
* <code>RelatedContactId</code>. </p>
|
|
7592
|
-
* @public
|
|
7593
|
-
*/
|
|
7594
|
-
RelatedContactId?: string | undefined;
|
|
7595
|
-
/**
|
|
7596
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an
|
|
7597
|
-
* attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
|
|
7598
|
-
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
7599
|
-
* <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created
|
|
7600
|
-
* a task.</p>
|
|
7601
|
-
* <note>
|
|
7602
|
-
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will
|
|
7603
|
-
* be active for before expiring, with <code>SegmentAttributes</code> like \{ <code> "connect:ContactExpiry":
|
|
7604
|
-
* \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": 135\}\}\}\}</code>. </p>
|
|
7605
|
-
* <p>To set the created by user, a valid AgentResourceId must be supplied, with <code>SegmentAttributes</code> like
|
|
7606
|
-
* \{ <code>"connect:CreatedByUser" \{ "ValueString":
|
|
7607
|
-
* "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}</code>.
|
|
7608
|
-
* </p>
|
|
7609
|
-
* </note>
|
|
7610
|
-
* @public
|
|
7611
|
-
*/
|
|
7612
|
-
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
7613
|
-
/**
|
|
7614
|
-
* <p>List of S3 presigned URLs of task attachments and their file name. You can have a maximum of 5 attachments per task.</p>
|
|
7615
|
-
* @public
|
|
7616
|
-
*/
|
|
7617
|
-
Attachments?: TaskAttachment[] | undefined;
|
|
7618
|
-
}
|
|
7619
|
-
/**
|
|
7620
|
-
* @public
|
|
7621
|
-
*/
|
|
7622
|
-
export interface UpdateContactRequest {
|
|
7623
|
-
/**
|
|
7624
|
-
* <p>The identifier of the Connect Customer 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>
|
|
7625
|
-
* @public
|
|
7626
|
-
*/
|
|
7627
|
-
InstanceId: string | undefined;
|
|
7628
|
-
/**
|
|
7629
|
-
* <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
|
|
7630
|
-
* your contact center.</p>
|
|
7631
|
-
* @public
|
|
7632
|
-
*/
|
|
7633
|
-
ContactId: string | undefined;
|
|
7634
|
-
/**
|
|
7635
|
-
* <p>The name of the contact.</p>
|
|
7636
|
-
* @public
|
|
7637
|
-
*/
|
|
7638
|
-
Name?: string | undefined;
|
|
7639
|
-
/**
|
|
7640
|
-
* <p>The description of the contact.</p>
|
|
7641
|
-
* @public
|
|
7642
|
-
*/
|
|
7643
|
-
Description?: string | undefined;
|
|
7644
|
-
/**
|
|
7645
|
-
* <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
|
|
7646
|
-
* @public
|
|
7647
|
-
*/
|
|
7648
|
-
References?: Record<string, Reference> | undefined;
|
|
7649
|
-
/**
|
|
7650
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an
|
|
7651
|
-
* attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
|
|
7652
|
-
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
7653
|
-
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
7654
|
-
* <p>Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be
|
|
7655
|
-
* updated by using the UpdateContact API.</p>
|
|
7656
|
-
* @public
|
|
7657
|
-
*/
|
|
7658
|
-
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
7659
|
-
/**
|
|
7660
|
-
* <p> Information about the queue associated with a contact. This parameter can only be updated for external audio
|
|
7661
|
-
* contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in
|
|
7662
|
-
* the <i>
|
|
7663
|
-
* Connect Customer Administrator Guide</i>.</p>
|
|
7664
|
-
* @public
|
|
7665
|
-
*/
|
|
7666
|
-
QueueInfo?: QueueInfoInput | undefined;
|
|
7667
|
-
/**
|
|
7668
|
-
* <p>Information about the agent associated with a contact. This parameter can only be updated for external audio
|
|
7669
|
-
* contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in
|
|
7670
|
-
* the <i>
|
|
7671
|
-
* Connect Customer Administrator Guide</i>.</p>
|
|
7672
|
-
* @public
|
|
7673
|
-
*/
|
|
7674
|
-
UserInfo?: UserInfo | undefined;
|
|
7675
|
-
/**
|
|
7676
|
-
* <p>The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually
|
|
7677
|
-
* the end customer's phone number. This value can only be updated for external audio contacts. For more information,
|
|
7678
|
-
* see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer
|
|
7679
|
-
* Contact Lens integration</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
7680
|
-
* @public
|
|
7681
|
-
*/
|
|
7682
|
-
CustomerEndpoint?: Endpoint | undefined;
|
|
7683
|
-
/**
|
|
7684
|
-
* <p>External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of
|
|
7685
|
-
* the external system such as the contact center. This value can only be updated for external audio contacts. For more
|
|
7686
|
-
* information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in the <i>Connect Customer Administrator
|
|
7687
|
-
* Guide</i>.</p>
|
|
7688
|
-
* @public
|
|
7689
|
-
*/
|
|
7690
|
-
SystemEndpoint?: Endpoint | undefined;
|
|
7691
|
-
}
|
|
7692
|
-
/**
|
|
7693
|
-
* <p>Information about an item from an evaluation form. The item must be either a section or a question.</p>
|
|
7694
|
-
* @public
|
|
7695
|
-
*/
|
|
7696
|
-
export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationFormItem.SectionMember | EvaluationFormItem.$UnknownMember;
|
|
7697
|
-
/**
|
|
7698
|
-
* @public
|
|
7699
|
-
*/
|
|
7700
|
-
export declare namespace EvaluationFormItem {
|
|
7701
|
-
/**
|
|
7702
|
-
* <p>The information of the section.</p>
|
|
7703
|
-
* @public
|
|
7704
|
-
*/
|
|
7705
|
-
interface SectionMember {
|
|
7706
|
-
Section: EvaluationFormSection;
|
|
7707
|
-
Question?: never;
|
|
7708
|
-
$unknown?: never;
|
|
7709
|
-
}
|
|
7710
|
-
/**
|
|
7711
|
-
* <p>The information of the question.</p>
|
|
7712
|
-
* @public
|
|
7713
|
-
*/
|
|
7714
|
-
interface QuestionMember {
|
|
7715
|
-
Section?: never;
|
|
7716
|
-
Question: EvaluationFormQuestion;
|
|
7717
|
-
$unknown?: never;
|
|
7718
|
-
}
|
|
7719
|
-
/**
|
|
7720
|
-
* @public
|
|
7721
|
-
*/
|
|
7722
|
-
interface $UnknownMember {
|
|
7723
|
-
Section?: never;
|
|
7724
|
-
Question?: never;
|
|
7725
|
-
$unknown: [string, any];
|
|
7726
|
-
}
|
|
7727
|
-
/**
|
|
7728
|
-
* @deprecated unused in schema-serde mode.
|
|
7729
|
-
*
|
|
7730
|
-
*/
|
|
7731
|
-
interface Visitor<T> {
|
|
7732
|
-
Section: (value: EvaluationFormSection) => T;
|
|
7733
|
-
Question: (value: EvaluationFormQuestion) => T;
|
|
7734
|
-
_: (name: string, value: any) => T;
|
|
7735
|
-
}
|
|
7736
|
-
}
|
|
7737
|
-
/**
|
|
7738
|
-
* <p>Latest routing criteria on the contact.</p>
|
|
7739
|
-
* @public
|
|
7740
|
-
*/
|
|
7741
|
-
export interface RoutingCriteria {
|
|
7742
|
-
/**
|
|
7743
|
-
* <p>List of routing steps. When Connect Customer does not find an available agent meeting the requirements in a
|
|
7744
|
-
* step for a given step duration, the routing criteria will move on to the next step sequentially until a join is
|
|
7745
|
-
* completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.</p>
|
|
7746
|
-
* @public
|
|
7747
|
-
*/
|
|
7748
|
-
Steps?: Step[] | undefined;
|
|
7749
|
-
/**
|
|
7750
|
-
* <p>The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when
|
|
7751
|
-
* contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue
|
|
7752
|
-
* even though Routing criteria is never activated for contacts in agent queue.</p>
|
|
7753
|
-
* @public
|
|
7754
|
-
*/
|
|
7755
|
-
ActivationTimestamp?: Date | undefined;
|
|
7756
|
-
/**
|
|
7757
|
-
* <p>Information about the index of the routing criteria.</p>
|
|
7758
|
-
* @public
|
|
7759
|
-
*/
|
|
7760
|
-
Index?: number | undefined;
|
|
7761
|
-
}
|
|
7762
|
-
/**
|
|
7763
|
-
* <p>An object to define the RoutingCriteria.</p>
|
|
7764
|
-
* @public
|
|
7765
|
-
*/
|
|
7766
|
-
export interface RoutingCriteriaInput {
|
|
7767
|
-
/**
|
|
7768
|
-
* <p>When Connect Customer does not find an available agent meeting the requirements in a step for a given step
|
|
7769
|
-
* duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent.
|
|
7770
|
-
* When all steps are exhausted, the contact will be offered to any agent in the queue.</p>
|
|
7771
|
-
* @public
|
|
7772
|
-
*/
|
|
7773
|
-
Steps?: RoutingCriteriaInputStep[] | undefined;
|
|
7774
|
-
}
|
|
7775
|
-
/**
|
|
7776
|
-
* <p>Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation
|
|
7777
|
-
* forms can only contain sections and subsections (two level nesting).</p>
|
|
7778
|
-
* @public
|
|
7779
|
-
*/
|
|
7780
|
-
export interface EvaluationFormSection {
|
|
7781
|
-
/**
|
|
7782
|
-
* <p>The title of the section.</p>
|
|
7783
|
-
* @public
|
|
7784
|
-
*/
|
|
7785
|
-
Title: string | undefined;
|
|
7786
|
-
/**
|
|
7787
|
-
* <p>The identifier of the section. An identifier must be unique within the evaluation form.</p>
|
|
7788
|
-
* @public
|
|
7789
|
-
*/
|
|
7790
|
-
RefId: string | undefined;
|
|
7791
|
-
/**
|
|
7792
|
-
* <p>The instructions of the section.</p>
|
|
7793
|
-
* @public
|
|
7794
|
-
*/
|
|
7795
|
-
Instructions?: string | undefined;
|
|
7796
|
-
/**
|
|
7797
|
-
* <p>The items of the section.</p>
|
|
7798
|
-
* @public
|
|
7799
|
-
*/
|
|
7800
|
-
Items: EvaluationFormItem[] | undefined;
|
|
7801
|
-
/**
|
|
7802
|
-
* <p>The scoring weight of the section.</p>
|
|
7803
|
-
* @public
|
|
7804
|
-
*/
|
|
7805
|
-
Weight?: number | undefined;
|
|
7806
|
-
/**
|
|
7807
|
-
* <p>The flag to exclude the section from scoring.</p>
|
|
7808
|
-
* @public
|
|
7809
|
-
*/
|
|
7810
|
-
IsExcludedFromScoring?: boolean | undefined;
|
|
7811
|
-
/**
|
|
7812
|
-
* <p>The score thresholds for performance categories.</p>
|
|
7813
|
-
* @public
|
|
7814
|
-
*/
|
|
7815
|
-
ScoreThresholds?: EvaluationFormScoreThreshold[] | undefined;
|
|
7816
|
-
}
|
|
7817
|
-
/**
|
|
7818
|
-
* @public
|
|
7819
|
-
*/
|
|
7820
|
-
export interface CreateEvaluationFormRequest {
|
|
7821
|
-
/**
|
|
7822
|
-
* <p>The identifier of the Connect Customer 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>
|
|
7823
|
-
* @public
|
|
7824
|
-
*/
|
|
7825
|
-
InstanceId: string | undefined;
|
|
7826
|
-
/**
|
|
7827
|
-
* <p>A title of the evaluation form.</p>
|
|
7828
|
-
* @public
|
|
7829
|
-
*/
|
|
7830
|
-
Title: string | undefined;
|
|
7831
|
-
/**
|
|
7832
|
-
* <p>The description of the evaluation form.</p>
|
|
7833
|
-
* @public
|
|
7834
|
-
*/
|
|
7835
|
-
Description?: string | undefined;
|
|
7836
|
-
/**
|
|
7837
|
-
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
7838
|
-
* @public
|
|
7839
|
-
*/
|
|
7840
|
-
Items: EvaluationFormItem[] | undefined;
|
|
7841
|
-
/**
|
|
7842
|
-
* <p>A scoring strategy of the evaluation form.</p>
|
|
7843
|
-
* @public
|
|
7844
|
-
*/
|
|
7845
|
-
ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
|
|
7846
|
-
/**
|
|
7847
|
-
* <p>Configuration information about automated evaluations.</p>
|
|
7848
|
-
* @public
|
|
7849
|
-
*/
|
|
7850
|
-
AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | undefined;
|
|
7851
|
-
/**
|
|
7852
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
7853
|
-
* request. If not provided, the Amazon Web Services
|
|
7854
|
-
* SDK populates this field. For more information about idempotency, see
|
|
7855
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
7856
|
-
* @public
|
|
7857
|
-
*/
|
|
7858
|
-
ClientToken?: string | undefined;
|
|
7859
|
-
/**
|
|
7860
|
-
* <p>A boolean flag indicating whether to create evaluation form in draft state.</p>
|
|
7861
|
-
* @public
|
|
7862
|
-
*/
|
|
7863
|
-
AsDraft?: boolean | undefined;
|
|
7864
|
-
/**
|
|
7865
|
-
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
7866
|
-
* @public
|
|
7867
|
-
*/
|
|
7868
|
-
Tags?: Record<string, string> | undefined;
|
|
7869
|
-
/**
|
|
7870
|
-
* <p>Configuration information about evaluation reviews.</p>
|
|
7871
|
-
* @public
|
|
7872
|
-
*/
|
|
7873
|
-
ReviewConfiguration?: EvaluationReviewConfiguration | undefined;
|
|
7874
|
-
/**
|
|
7875
|
-
* <p>Configuration that specifies the target for the evaluation form.</p>
|
|
7876
|
-
* @public
|
|
7877
|
-
*/
|
|
7878
|
-
TargetConfiguration?: EvaluationFormTargetConfiguration | undefined;
|
|
7879
|
-
/**
|
|
7880
|
-
* <p>Configuration for language settings of the evaluation form.</p>
|
|
7881
|
-
* @public
|
|
7882
|
-
*/
|
|
7883
|
-
LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined;
|
|
7884
|
-
}
|