aws-sdk-connect 1.205.0 → 1.206.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +63 -19
- data/lib/aws-sdk-connect/client_api.rb +33 -0
- data/lib/aws-sdk-connect/types.rb +160 -14
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/types.rbs +33 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 35bcd121540c0f93e903602302b096cc8b5ae3764495dac5c479e1b7733ede10
|
4
|
+
data.tar.gz: 9c7208c9bcb1f4fc1412d09af84a7f2ffd6a9f3382363b820ed82a65ba5ee074
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5075fac512c0fa6702713fc5049c5930045930bbac3f017b89cf94c449ef6fce5681738682a9013913a62489f9fecf9f900c36f19ef468ce9bf46af0d05009f1
|
7
|
+
data.tar.gz: d2d287e971fecd5b3471a05b5b66ca4dd8cd1ed3a44d80906c165ef0e969b273ac0548b909c721e4c96c0cd661854139edf1452c43f4eca27a51b3663f451464
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.206.0 (2025-06-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces ChatMetrics to the model, providing comprehensive analytics insights for Amazon Connect chat conversations. Users can access these detailed metrics through the AWS Connect API by using the DescribeContact operation with their specific instance and contact IDs
|
8
|
+
|
4
9
|
1.205.0 (2025-06-27)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.206.0
|
@@ -1769,12 +1769,26 @@ module Aws::Connect
|
|
1769
1769
|
req.send_request(options)
|
1770
1770
|
end
|
1771
1771
|
|
1772
|
-
# Only the EMAIL and
|
1773
|
-
# initiation methods for EMAIL are: OUTBOUND, AGENT\_REPLY, and FLOW.
|
1774
|
-
# For VOICE the supported initiation methods are TRANSFER and the
|
1775
|
-
# subtype connect:ExternalAudio.
|
1772
|
+
# Only the VOICE, EMAIL, and TASK channels are supported.
|
1776
1773
|
#
|
1777
|
-
#
|
1774
|
+
# * For VOICE: The supported initiation method is `TRANSFER`. The
|
1775
|
+
# contacts created with this initiation method have a subtype
|
1776
|
+
# `connect:ExternalAudio`.
|
1777
|
+
#
|
1778
|
+
# * For EMAIL: The supported initiation methods are `OUTBOUND`,
|
1779
|
+
# `AGENT_REPLY`, and `FLOW`.
|
1780
|
+
#
|
1781
|
+
# * For TASK: The supported initiation method is `API`. Contacts created
|
1782
|
+
# with this API have a sub-type of `connect:ExternalTask`.
|
1783
|
+
#
|
1784
|
+
# Creates a new VOICE, EMAIL, or TASK contact.
|
1785
|
+
#
|
1786
|
+
# After a contact is created, you can move it to the desired state by
|
1787
|
+
# using the `InitiateAs` parameter. While you can use API to create task
|
1788
|
+
# contacts that are in the `COMPLETED` state, you must contact Amazon
|
1789
|
+
# Web Services Support before using it for bulk import use cases. Bulk
|
1790
|
+
# import causes your requests to be throttled or fail if your
|
1791
|
+
# CreateContact limits aren't high enough.
|
1778
1792
|
#
|
1779
1793
|
# @option params [required, String] :instance_id
|
1780
1794
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -1812,26 +1826,29 @@ module Aws::Connect
|
|
1812
1826
|
# @option params [Hash<String,Types::Reference>] :references
|
1813
1827
|
# A formatted URL that is shown to an agent in the Contact Control Panel
|
1814
1828
|
# (CCP). Tasks can have the following reference types at the time of
|
1815
|
-
# creation: URL \| NUMBER \| STRING \| DATE \| EMAIL \|
|
1829
|
+
# creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \| `EMAIL` \|
|
1830
|
+
# `ATTACHMENT`.
|
1816
1831
|
#
|
1817
1832
|
# @option params [required, String] :channel
|
1818
|
-
# The channel for the contact
|
1833
|
+
# The channel for the contact.
|
1819
1834
|
#
|
1820
|
-
#
|
1821
|
-
#
|
1822
|
-
# incorrect. We are working to update this topic.
|
1835
|
+
# The CHAT channel is not supported. The following information is
|
1836
|
+
# incorrect. We're working to correct it.
|
1823
1837
|
#
|
1824
1838
|
# @option params [required, String] :initiation_method
|
1825
1839
|
# Indicates how the contact was initiated.
|
1826
1840
|
#
|
1827
|
-
# CreateContact only supports the following initiation methods
|
1841
|
+
# CreateContact only supports the following initiation methods. Valid
|
1842
|
+
# values by channel are:
|
1843
|
+
#
|
1844
|
+
# * For VOICE: `TRANSFER` and the subtype `connect:ExternalAudio`
|
1828
1845
|
#
|
1829
|
-
#
|
1846
|
+
# * For EMAIL: `OUTBOUND` \| `AGENT_REPLY` \| `FLOW`
|
1830
1847
|
#
|
1831
|
-
# * For
|
1848
|
+
# * For TASK: `API`
|
1832
1849
|
#
|
1833
|
-
# The
|
1834
|
-
#
|
1850
|
+
# The other channels listed below are incorrect. We're working to
|
1851
|
+
# correct this information.
|
1835
1852
|
#
|
1836
1853
|
# @option params [Integer] :expiry_duration_in_minutes
|
1837
1854
|
# Number of minutes the contact will be active for before expiring
|
@@ -1839,11 +1856,12 @@ module Aws::Connect
|
|
1839
1856
|
# @option params [Types::UserInfo] :user_info
|
1840
1857
|
# User details for the contact
|
1841
1858
|
#
|
1842
|
-
# UserInfo is required when creating an EMAIL contact with OUTBOUND
|
1843
|
-
#
|
1859
|
+
# UserInfo is required when creating an EMAIL contact with `OUTBOUND`
|
1860
|
+
# and `AGENT_REPLY` contact initiation methods.
|
1844
1861
|
#
|
1845
1862
|
# @option params [String] :initiate_as
|
1846
|
-
# Initial state of the contact when it's created
|
1863
|
+
# Initial state of the contact when it's created. Only TASK channel
|
1864
|
+
# contacts can be initiated with `COMPLETED` state.
|
1847
1865
|
#
|
1848
1866
|
# @option params [String] :name
|
1849
1867
|
# The name of a the contact.
|
@@ -5488,6 +5506,32 @@ module Aws::Connect
|
|
5488
5506
|
# resp.contact.quality_metrics.customer.audio.quality_score #=> Float
|
5489
5507
|
# resp.contact.quality_metrics.customer.audio.potential_quality_issues #=> Array
|
5490
5508
|
# resp.contact.quality_metrics.customer.audio.potential_quality_issues[0] #=> String
|
5509
|
+
# resp.contact.chat_metrics.chat_contact_metrics.multi_party #=> Boolean
|
5510
|
+
# resp.contact.chat_metrics.chat_contact_metrics.total_messages #=> Integer
|
5511
|
+
# resp.contact.chat_metrics.chat_contact_metrics.total_bot_messages #=> Integer
|
5512
|
+
# resp.contact.chat_metrics.chat_contact_metrics.total_bot_message_length_in_chars #=> Integer
|
5513
|
+
# resp.contact.chat_metrics.chat_contact_metrics.conversation_close_time_in_millis #=> Integer
|
5514
|
+
# resp.contact.chat_metrics.chat_contact_metrics.conversation_turn_count #=> Integer
|
5515
|
+
# resp.contact.chat_metrics.chat_contact_metrics.agent_first_response_timestamp #=> Time
|
5516
|
+
# resp.contact.chat_metrics.chat_contact_metrics.agent_first_response_time_in_millis #=> Integer
|
5517
|
+
# resp.contact.chat_metrics.agent_metrics.participant_id #=> String
|
5518
|
+
# resp.contact.chat_metrics.agent_metrics.participant_type #=> String, one of "ALL", "MANAGER", "AGENT", "CUSTOMER", "THIRDPARTY"
|
5519
|
+
# resp.contact.chat_metrics.agent_metrics.conversation_abandon #=> Boolean
|
5520
|
+
# resp.contact.chat_metrics.agent_metrics.messages_sent #=> Integer
|
5521
|
+
# resp.contact.chat_metrics.agent_metrics.num_responses #=> Integer
|
5522
|
+
# resp.contact.chat_metrics.agent_metrics.message_length_in_chars #=> Integer
|
5523
|
+
# resp.contact.chat_metrics.agent_metrics.total_response_time_in_millis #=> Integer
|
5524
|
+
# resp.contact.chat_metrics.agent_metrics.max_response_time_in_millis #=> Integer
|
5525
|
+
# resp.contact.chat_metrics.agent_metrics.last_message_timestamp #=> Time
|
5526
|
+
# resp.contact.chat_metrics.customer_metrics.participant_id #=> String
|
5527
|
+
# resp.contact.chat_metrics.customer_metrics.participant_type #=> String, one of "ALL", "MANAGER", "AGENT", "CUSTOMER", "THIRDPARTY"
|
5528
|
+
# resp.contact.chat_metrics.customer_metrics.conversation_abandon #=> Boolean
|
5529
|
+
# resp.contact.chat_metrics.customer_metrics.messages_sent #=> Integer
|
5530
|
+
# resp.contact.chat_metrics.customer_metrics.num_responses #=> Integer
|
5531
|
+
# resp.contact.chat_metrics.customer_metrics.message_length_in_chars #=> Integer
|
5532
|
+
# resp.contact.chat_metrics.customer_metrics.total_response_time_in_millis #=> Integer
|
5533
|
+
# resp.contact.chat_metrics.customer_metrics.max_response_time_in_millis #=> Integer
|
5534
|
+
# resp.contact.chat_metrics.customer_metrics.last_message_timestamp #=> Time
|
5491
5535
|
# resp.contact.disconnect_details.potential_disconnect_issue #=> String
|
5492
5536
|
# resp.contact.additional_email_recipients.to_list #=> Array
|
5493
5537
|
# resp.contact.additional_email_recipients.to_list[0].address #=> String
|
@@ -21208,7 +21252,7 @@ module Aws::Connect
|
|
21208
21252
|
tracer: tracer
|
21209
21253
|
)
|
21210
21254
|
context[:gem_name] = 'aws-sdk-connect'
|
21211
|
-
context[:gem_version] = '1.
|
21255
|
+
context[:gem_version] = '1.206.0'
|
21212
21256
|
Seahorse::Client::Request.new(handlers, context)
|
21213
21257
|
end
|
21214
21258
|
|
@@ -157,12 +157,14 @@ module Aws::Connect
|
|
157
157
|
ChannelList = Shapes::ListShape.new(name: 'ChannelList')
|
158
158
|
ChannelToCountMap = Shapes::MapShape.new(name: 'ChannelToCountMap')
|
159
159
|
Channels = Shapes::ListShape.new(name: 'Channels')
|
160
|
+
ChatContactMetrics = Shapes::StructureShape.new(name: 'ChatContactMetrics')
|
160
161
|
ChatContent = Shapes::StringShape.new(name: 'ChatContent')
|
161
162
|
ChatContentType = Shapes::StringShape.new(name: 'ChatContentType')
|
162
163
|
ChatDurationInMinutes = Shapes::IntegerShape.new(name: 'ChatDurationInMinutes')
|
163
164
|
ChatEvent = Shapes::StructureShape.new(name: 'ChatEvent')
|
164
165
|
ChatEventType = Shapes::StringShape.new(name: 'ChatEventType')
|
165
166
|
ChatMessage = Shapes::StructureShape.new(name: 'ChatMessage')
|
167
|
+
ChatMetrics = Shapes::StructureShape.new(name: 'ChatMetrics')
|
166
168
|
ChatParticipantRoleConfig = Shapes::StructureShape.new(name: 'ChatParticipantRoleConfig')
|
167
169
|
ChatStreamingConfiguration = Shapes::StructureShape.new(name: 'ChatStreamingConfiguration')
|
168
170
|
ChatStreamingEndpointARN = Shapes::StringShape.new(name: 'ChatStreamingEndpointARN')
|
@@ -249,6 +251,7 @@ module Aws::Connect
|
|
249
251
|
ControlPlaneAttributeFilter = Shapes::StructureShape.new(name: 'ControlPlaneAttributeFilter')
|
250
252
|
ControlPlaneTagFilter = Shapes::StructureShape.new(name: 'ControlPlaneTagFilter')
|
251
253
|
ControlPlaneUserAttributeFilter = Shapes::StructureShape.new(name: 'ControlPlaneUserAttributeFilter')
|
254
|
+
Count = Shapes::IntegerShape.new(name: 'Count')
|
252
255
|
CreateAgentStatusRequest = Shapes::StructureShape.new(name: 'CreateAgentStatusRequest')
|
253
256
|
CreateAgentStatusResponse = Shapes::StructureShape.new(name: 'CreateAgentStatusResponse')
|
254
257
|
CreateCaseActionDefinition = Shapes::StructureShape.new(name: 'CreateCaseActionDefinition')
|
@@ -472,6 +475,7 @@ module Aws::Connect
|
|
472
475
|
DuplicateResourceException = Shapes::StructureShape.new(name: 'DuplicateResourceException')
|
473
476
|
Duration = Shapes::IntegerShape.new(name: 'Duration')
|
474
477
|
DurationInSeconds = Shapes::IntegerShape.new(name: 'DurationInSeconds')
|
478
|
+
DurationMillis = Shapes::IntegerShape.new(name: 'DurationMillis')
|
475
479
|
EffectiveHoursOfOperationList = Shapes::ListShape.new(name: 'EffectiveHoursOfOperationList')
|
476
480
|
EffectiveHoursOfOperations = Shapes::StructureShape.new(name: 'EffectiveHoursOfOperations')
|
477
481
|
Email = Shapes::StringShape.new(name: 'Email')
|
@@ -894,6 +898,7 @@ module Aws::Connect
|
|
894
898
|
NotificationContentType = Shapes::StringShape.new(name: 'NotificationContentType')
|
895
899
|
NotificationDeliveryType = Shapes::StringShape.new(name: 'NotificationDeliveryType')
|
896
900
|
NotificationRecipientType = Shapes::StructureShape.new(name: 'NotificationRecipientType')
|
901
|
+
NullableBoolean = Shapes::BooleanShape.new(name: 'NullableBoolean')
|
897
902
|
NullableProficiencyLevel = Shapes::FloatShape.new(name: 'NullableProficiencyLevel')
|
898
903
|
NullableProficiencyLimitValue = Shapes::IntegerShape.new(name: 'NullableProficiencyLimitValue')
|
899
904
|
NumberComparisonType = Shapes::StringShape.new(name: 'NumberComparisonType')
|
@@ -925,6 +930,7 @@ module Aws::Connect
|
|
925
930
|
ParticipantDetails = Shapes::StructureShape.new(name: 'ParticipantDetails')
|
926
931
|
ParticipantDetailsToAdd = Shapes::StructureShape.new(name: 'ParticipantDetailsToAdd')
|
927
932
|
ParticipantId = Shapes::StringShape.new(name: 'ParticipantId')
|
933
|
+
ParticipantMetrics = Shapes::StructureShape.new(name: 'ParticipantMetrics')
|
928
934
|
ParticipantRole = Shapes::StringShape.new(name: 'ParticipantRole')
|
929
935
|
ParticipantState = Shapes::StringShape.new(name: 'ParticipantState')
|
930
936
|
ParticipantTimerAction = Shapes::StringShape.new(name: 'ParticipantTimerAction')
|
@@ -1967,6 +1973,16 @@ module Aws::Connect
|
|
1967
1973
|
|
1968
1974
|
Channels.member = Shapes::ShapeRef.new(shape: Channel)
|
1969
1975
|
|
1976
|
+
ChatContactMetrics.add_member(:multi_party, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "MultiParty"))
|
1977
|
+
ChatContactMetrics.add_member(:total_messages, Shapes::ShapeRef.new(shape: Count, location_name: "TotalMessages"))
|
1978
|
+
ChatContactMetrics.add_member(:total_bot_messages, Shapes::ShapeRef.new(shape: Count, location_name: "TotalBotMessages"))
|
1979
|
+
ChatContactMetrics.add_member(:total_bot_message_length_in_chars, Shapes::ShapeRef.new(shape: Count, location_name: "TotalBotMessageLengthInChars"))
|
1980
|
+
ChatContactMetrics.add_member(:conversation_close_time_in_millis, Shapes::ShapeRef.new(shape: DurationMillis, location_name: "ConversationCloseTimeInMillis"))
|
1981
|
+
ChatContactMetrics.add_member(:conversation_turn_count, Shapes::ShapeRef.new(shape: Count, location_name: "ConversationTurnCount"))
|
1982
|
+
ChatContactMetrics.add_member(:agent_first_response_timestamp, Shapes::ShapeRef.new(shape: timestamp, location_name: "AgentFirstResponseTimestamp"))
|
1983
|
+
ChatContactMetrics.add_member(:agent_first_response_time_in_millis, Shapes::ShapeRef.new(shape: DurationMillis, location_name: "AgentFirstResponseTimeInMillis"))
|
1984
|
+
ChatContactMetrics.struct_class = Types::ChatContactMetrics
|
1985
|
+
|
1970
1986
|
ChatEvent.add_member(:type, Shapes::ShapeRef.new(shape: ChatEventType, required: true, location_name: "Type"))
|
1971
1987
|
ChatEvent.add_member(:content_type, Shapes::ShapeRef.new(shape: ChatContentType, location_name: "ContentType"))
|
1972
1988
|
ChatEvent.add_member(:content, Shapes::ShapeRef.new(shape: ChatContent, location_name: "Content"))
|
@@ -1976,6 +1992,11 @@ module Aws::Connect
|
|
1976
1992
|
ChatMessage.add_member(:content, Shapes::ShapeRef.new(shape: ChatContent, required: true, location_name: "Content"))
|
1977
1993
|
ChatMessage.struct_class = Types::ChatMessage
|
1978
1994
|
|
1995
|
+
ChatMetrics.add_member(:chat_contact_metrics, Shapes::ShapeRef.new(shape: ChatContactMetrics, location_name: "ChatContactMetrics"))
|
1996
|
+
ChatMetrics.add_member(:agent_metrics, Shapes::ShapeRef.new(shape: ParticipantMetrics, location_name: "AgentMetrics"))
|
1997
|
+
ChatMetrics.add_member(:customer_metrics, Shapes::ShapeRef.new(shape: ParticipantMetrics, location_name: "CustomerMetrics"))
|
1998
|
+
ChatMetrics.struct_class = Types::ChatMetrics
|
1999
|
+
|
1979
2000
|
ChatParticipantRoleConfig.add_member(:participant_timer_config_list, Shapes::ShapeRef.new(shape: ParticipantTimerConfigList, required: true, location_name: "ParticipantTimerConfigList"))
|
1980
2001
|
ChatParticipantRoleConfig.struct_class = Types::ChatParticipantRoleConfig
|
1981
2002
|
|
@@ -2069,6 +2090,7 @@ module Aws::Connect
|
|
2069
2090
|
Contact.add_member(:answering_machine_detection_status, Shapes::ShapeRef.new(shape: AnsweringMachineDetectionStatus, location_name: "AnsweringMachineDetectionStatus"))
|
2070
2091
|
Contact.add_member(:customer_voice_activity, Shapes::ShapeRef.new(shape: CustomerVoiceActivity, location_name: "CustomerVoiceActivity"))
|
2071
2092
|
Contact.add_member(:quality_metrics, Shapes::ShapeRef.new(shape: QualityMetrics, location_name: "QualityMetrics"))
|
2093
|
+
Contact.add_member(:chat_metrics, Shapes::ShapeRef.new(shape: ChatMetrics, location_name: "ChatMetrics"))
|
2072
2094
|
Contact.add_member(:disconnect_details, Shapes::ShapeRef.new(shape: DisconnectDetails, location_name: "DisconnectDetails"))
|
2073
2095
|
Contact.add_member(:additional_email_recipients, Shapes::ShapeRef.new(shape: AdditionalEmailRecipients, location_name: "AdditionalEmailRecipients"))
|
2074
2096
|
Contact.add_member(:segment_attributes, Shapes::ShapeRef.new(shape: SegmentAttributes, location_name: "SegmentAttributes"))
|
@@ -4611,6 +4633,17 @@ module Aws::Connect
|
|
4611
4633
|
ParticipantDetailsToAdd.add_member(:display_name, Shapes::ShapeRef.new(shape: DisplayName, location_name: "DisplayName"))
|
4612
4634
|
ParticipantDetailsToAdd.struct_class = Types::ParticipantDetailsToAdd
|
4613
4635
|
|
4636
|
+
ParticipantMetrics.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, location_name: "ParticipantId"))
|
4637
|
+
ParticipantMetrics.add_member(:participant_type, Shapes::ShapeRef.new(shape: ParticipantType, location_name: "ParticipantType"))
|
4638
|
+
ParticipantMetrics.add_member(:conversation_abandon, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ConversationAbandon"))
|
4639
|
+
ParticipantMetrics.add_member(:messages_sent, Shapes::ShapeRef.new(shape: Count, location_name: "MessagesSent"))
|
4640
|
+
ParticipantMetrics.add_member(:num_responses, Shapes::ShapeRef.new(shape: Count, location_name: "NumResponses"))
|
4641
|
+
ParticipantMetrics.add_member(:message_length_in_chars, Shapes::ShapeRef.new(shape: Count, location_name: "MessageLengthInChars"))
|
4642
|
+
ParticipantMetrics.add_member(:total_response_time_in_millis, Shapes::ShapeRef.new(shape: DurationMillis, location_name: "TotalResponseTimeInMillis"))
|
4643
|
+
ParticipantMetrics.add_member(:max_response_time_in_millis, Shapes::ShapeRef.new(shape: DurationMillis, location_name: "MaxResponseTimeInMillis"))
|
4644
|
+
ParticipantMetrics.add_member(:last_message_timestamp, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastMessageTimestamp"))
|
4645
|
+
ParticipantMetrics.struct_class = Types::ParticipantMetrics
|
4646
|
+
|
4614
4647
|
ParticipantTimerConfigList.member = Shapes::ShapeRef.new(shape: ParticipantTimerConfiguration)
|
4615
4648
|
|
4616
4649
|
ParticipantTimerConfiguration.add_member(:participant_role, Shapes::ShapeRef.new(shape: TimerEligibleParticipantRoles, required: true, location_name: "ParticipantRole"))
|
@@ -2046,6 +2046,61 @@ module Aws::Connect
|
|
2046
2046
|
include Aws::Structure
|
2047
2047
|
end
|
2048
2048
|
|
2049
|
+
# Information about the overall participant interactions at the contact
|
2050
|
+
# level.
|
2051
|
+
#
|
2052
|
+
# @!attribute [rw] multi_party
|
2053
|
+
# A boolean flag indicating whether multiparty chat or supervisor
|
2054
|
+
# barge were enabled on this contact.
|
2055
|
+
# @return [Boolean]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] total_messages
|
2058
|
+
# The number of chat messages on the contact.
|
2059
|
+
# @return [Integer]
|
2060
|
+
#
|
2061
|
+
# @!attribute [rw] total_bot_messages
|
2062
|
+
# The total number of bot and automated messages on a chat contact.
|
2063
|
+
# @return [Integer]
|
2064
|
+
#
|
2065
|
+
# @!attribute [rw] total_bot_message_length_in_chars
|
2066
|
+
# The total number of characters from bot and automated messages on a
|
2067
|
+
# chat contact.
|
2068
|
+
# @return [Integer]
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] conversation_close_time_in_millis
|
2071
|
+
# The time it took for a contact to end after the last customer
|
2072
|
+
# message.
|
2073
|
+
# @return [Integer]
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] conversation_turn_count
|
2076
|
+
# The number of conversation turns in a chat contact, which represents
|
2077
|
+
# the back-and-forth exchanges between customer and other
|
2078
|
+
# participants.
|
2079
|
+
# @return [Integer]
|
2080
|
+
#
|
2081
|
+
# @!attribute [rw] agent_first_response_timestamp
|
2082
|
+
# The agent first response timestamp for a chat contact.
|
2083
|
+
# @return [Time]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] agent_first_response_time_in_millis
|
2086
|
+
# The time for an agent to respond after obtaining a chat contact.
|
2087
|
+
# @return [Integer]
|
2088
|
+
#
|
2089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ChatContactMetrics AWS API Documentation
|
2090
|
+
#
|
2091
|
+
class ChatContactMetrics < Struct.new(
|
2092
|
+
:multi_party,
|
2093
|
+
:total_messages,
|
2094
|
+
:total_bot_messages,
|
2095
|
+
:total_bot_message_length_in_chars,
|
2096
|
+
:conversation_close_time_in_millis,
|
2097
|
+
:conversation_turn_count,
|
2098
|
+
:agent_first_response_timestamp,
|
2099
|
+
:agent_first_response_time_in_millis)
|
2100
|
+
SENSITIVE = []
|
2101
|
+
include Aws::Structure
|
2102
|
+
end
|
2103
|
+
|
2049
2104
|
# Chat integration event containing payload to perform different chat
|
2050
2105
|
# actions such as:
|
2051
2106
|
#
|
@@ -2136,6 +2191,32 @@ module Aws::Connect
|
|
2136
2191
|
include Aws::Structure
|
2137
2192
|
end
|
2138
2193
|
|
2194
|
+
# Information about how agent, bot, and customer interact in a chat
|
2195
|
+
# contact.
|
2196
|
+
#
|
2197
|
+
# @!attribute [rw] chat_contact_metrics
|
2198
|
+
# Information about the overall participant interactions at the
|
2199
|
+
# contact level.
|
2200
|
+
# @return [Types::ChatContactMetrics]
|
2201
|
+
#
|
2202
|
+
# @!attribute [rw] agent_metrics
|
2203
|
+
# Information about agent interactions in a contact.
|
2204
|
+
# @return [Types::ParticipantMetrics]
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] customer_metrics
|
2207
|
+
# Information about customer interactions in a contact.
|
2208
|
+
# @return [Types::ParticipantMetrics]
|
2209
|
+
#
|
2210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ChatMetrics AWS API Documentation
|
2211
|
+
#
|
2212
|
+
class ChatMetrics < Struct.new(
|
2213
|
+
:chat_contact_metrics,
|
2214
|
+
:agent_metrics,
|
2215
|
+
:customer_metrics)
|
2216
|
+
SENSITIVE = []
|
2217
|
+
include Aws::Structure
|
2218
|
+
end
|
2219
|
+
|
2139
2220
|
# Configuration information for the chat participant role.
|
2140
2221
|
#
|
2141
2222
|
# @!attribute [rw] participant_timer_config_list
|
@@ -2667,6 +2748,11 @@ module Aws::Connect
|
|
2667
2748
|
# connection.
|
2668
2749
|
# @return [Types::QualityMetrics]
|
2669
2750
|
#
|
2751
|
+
# @!attribute [rw] chat_metrics
|
2752
|
+
# Information about how agent, bot, and customer interact in a chat
|
2753
|
+
# contact.
|
2754
|
+
# @return [Types::ChatMetrics]
|
2755
|
+
#
|
2670
2756
|
# @!attribute [rw] disconnect_details
|
2671
2757
|
# Information about the call disconnect experience.
|
2672
2758
|
# @return [Types::DisconnectDetails]
|
@@ -2744,6 +2830,7 @@ module Aws::Connect
|
|
2744
2830
|
:answering_machine_detection_status,
|
2745
2831
|
:customer_voice_activity,
|
2746
2832
|
:quality_metrics,
|
2833
|
+
:chat_metrics,
|
2747
2834
|
:disconnect_details,
|
2748
2835
|
:additional_email_recipients,
|
2749
2836
|
:segment_attributes,
|
@@ -3923,29 +4010,31 @@ module Aws::Connect
|
|
3923
4010
|
# @!attribute [rw] references
|
3924
4011
|
# A formatted URL that is shown to an agent in the Contact Control
|
3925
4012
|
# Panel (CCP). Tasks can have the following reference types at the
|
3926
|
-
# time of creation: URL \| NUMBER \| STRING \| DATE \| EMAIL
|
3927
|
-
# ATTACHMENT
|
4013
|
+
# time of creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \| `EMAIL`
|
4014
|
+
# \| `ATTACHMENT`.
|
3928
4015
|
# @return [Hash<String,Types::Reference>]
|
3929
4016
|
#
|
3930
4017
|
# @!attribute [rw] channel
|
3931
|
-
# The channel for the contact
|
4018
|
+
# The channel for the contact.
|
3932
4019
|
#
|
3933
|
-
#
|
3934
|
-
#
|
3935
|
-
# incorrect. We are working to update this topic.
|
4020
|
+
# The CHAT channel is not supported. The following information is
|
4021
|
+
# incorrect. We're working to correct it.
|
3936
4022
|
# @return [String]
|
3937
4023
|
#
|
3938
4024
|
# @!attribute [rw] initiation_method
|
3939
4025
|
# Indicates how the contact was initiated.
|
3940
4026
|
#
|
3941
|
-
# CreateContact only supports the following initiation methods
|
4027
|
+
# CreateContact only supports the following initiation methods. Valid
|
4028
|
+
# values by channel are:
|
3942
4029
|
#
|
3943
|
-
# * For
|
4030
|
+
# * For VOICE: `TRANSFER` and the subtype `connect:ExternalAudio`
|
3944
4031
|
#
|
3945
|
-
# * For
|
4032
|
+
# * For EMAIL: `OUTBOUND` \| `AGENT_REPLY` \| `FLOW`
|
3946
4033
|
#
|
3947
|
-
#
|
3948
|
-
#
|
4034
|
+
# * For TASK: `API`
|
4035
|
+
#
|
4036
|
+
# The other channels listed below are incorrect. We're working to
|
4037
|
+
# correct this information.
|
3949
4038
|
# @return [String]
|
3950
4039
|
#
|
3951
4040
|
# @!attribute [rw] expiry_duration_in_minutes
|
@@ -3955,12 +4044,13 @@ module Aws::Connect
|
|
3955
4044
|
# @!attribute [rw] user_info
|
3956
4045
|
# User details for the contact
|
3957
4046
|
#
|
3958
|
-
# UserInfo is required when creating an EMAIL contact with OUTBOUND
|
3959
|
-
# and
|
4047
|
+
# UserInfo is required when creating an EMAIL contact with `OUTBOUND`
|
4048
|
+
# and `AGENT_REPLY` contact initiation methods.
|
3960
4049
|
# @return [Types::UserInfo]
|
3961
4050
|
#
|
3962
4051
|
# @!attribute [rw] initiate_as
|
3963
|
-
# Initial state of the contact when it's created
|
4052
|
+
# Initial state of the contact when it's created. Only TASK channel
|
4053
|
+
# contacts can be initiated with `COMPLETED` state.
|
3964
4054
|
# @return [String]
|
3965
4055
|
#
|
3966
4056
|
# @!attribute [rw] name
|
@@ -17401,6 +17491,62 @@ module Aws::Connect
|
|
17401
17491
|
include Aws::Structure
|
17402
17492
|
end
|
17403
17493
|
|
17494
|
+
# Information about a participant's interactions in a contact.
|
17495
|
+
#
|
17496
|
+
# @!attribute [rw] participant_id
|
17497
|
+
# The Participant's ID.
|
17498
|
+
# @return [String]
|
17499
|
+
#
|
17500
|
+
# @!attribute [rw] participant_type
|
17501
|
+
# Information about the conversation participant. Following are the
|
17502
|
+
# participant types: \[Agent, Customer, Supervisor\].
|
17503
|
+
# @return [String]
|
17504
|
+
#
|
17505
|
+
# @!attribute [rw] conversation_abandon
|
17506
|
+
# A boolean flag indicating whether the chat conversation was
|
17507
|
+
# abandoned by a Participant.
|
17508
|
+
# @return [Boolean]
|
17509
|
+
#
|
17510
|
+
# @!attribute [rw] messages_sent
|
17511
|
+
# Number of chat messages sent by Participant.
|
17512
|
+
# @return [Integer]
|
17513
|
+
#
|
17514
|
+
# @!attribute [rw] num_responses
|
17515
|
+
# Number of chat messages sent by Participant.
|
17516
|
+
# @return [Integer]
|
17517
|
+
#
|
17518
|
+
# @!attribute [rw] message_length_in_chars
|
17519
|
+
# Number of chat characters sent by Participant.
|
17520
|
+
# @return [Integer]
|
17521
|
+
#
|
17522
|
+
# @!attribute [rw] total_response_time_in_millis
|
17523
|
+
# Total chat response time by Participant.
|
17524
|
+
# @return [Integer]
|
17525
|
+
#
|
17526
|
+
# @!attribute [rw] max_response_time_in_millis
|
17527
|
+
# Maximum chat response time by Participant.
|
17528
|
+
# @return [Integer]
|
17529
|
+
#
|
17530
|
+
# @!attribute [rw] last_message_timestamp
|
17531
|
+
# Timestamp of last chat message by Participant.
|
17532
|
+
# @return [Time]
|
17533
|
+
#
|
17534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantMetrics AWS API Documentation
|
17535
|
+
#
|
17536
|
+
class ParticipantMetrics < Struct.new(
|
17537
|
+
:participant_id,
|
17538
|
+
:participant_type,
|
17539
|
+
:conversation_abandon,
|
17540
|
+
:messages_sent,
|
17541
|
+
:num_responses,
|
17542
|
+
:message_length_in_chars,
|
17543
|
+
:total_response_time_in_millis,
|
17544
|
+
:max_response_time_in_millis,
|
17545
|
+
:last_message_timestamp)
|
17546
|
+
SENSITIVE = []
|
17547
|
+
include Aws::Structure
|
17548
|
+
end
|
17549
|
+
|
17404
17550
|
# Configuration information for the timer. After the timer configuration
|
17405
17551
|
# is set, it persists for the duration of the chat. It persists across
|
17406
17552
|
# new contacts in the chain, for example, transfer contacts.
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/types.rbs
CHANGED
@@ -498,6 +498,18 @@ module Aws::Connect
|
|
498
498
|
SENSITIVE: []
|
499
499
|
end
|
500
500
|
|
501
|
+
class ChatContactMetrics
|
502
|
+
attr_accessor multi_party: bool
|
503
|
+
attr_accessor total_messages: ::Integer
|
504
|
+
attr_accessor total_bot_messages: ::Integer
|
505
|
+
attr_accessor total_bot_message_length_in_chars: ::Integer
|
506
|
+
attr_accessor conversation_close_time_in_millis: ::Integer
|
507
|
+
attr_accessor conversation_turn_count: ::Integer
|
508
|
+
attr_accessor agent_first_response_timestamp: ::Time
|
509
|
+
attr_accessor agent_first_response_time_in_millis: ::Integer
|
510
|
+
SENSITIVE: []
|
511
|
+
end
|
512
|
+
|
501
513
|
class ChatEvent
|
502
514
|
attr_accessor type: ("DISCONNECT" | "MESSAGE" | "EVENT")
|
503
515
|
attr_accessor content_type: ::String
|
@@ -511,6 +523,13 @@ module Aws::Connect
|
|
511
523
|
SENSITIVE: []
|
512
524
|
end
|
513
525
|
|
526
|
+
class ChatMetrics
|
527
|
+
attr_accessor chat_contact_metrics: Types::ChatContactMetrics
|
528
|
+
attr_accessor agent_metrics: Types::ParticipantMetrics
|
529
|
+
attr_accessor customer_metrics: Types::ParticipantMetrics
|
530
|
+
SENSITIVE: []
|
531
|
+
end
|
532
|
+
|
514
533
|
class ChatParticipantRoleConfig
|
515
534
|
attr_accessor participant_timer_config_list: ::Array[Types::ParticipantTimerConfiguration]
|
516
535
|
SENSITIVE: []
|
@@ -624,6 +643,7 @@ module Aws::Connect
|
|
624
643
|
attr_accessor answering_machine_detection_status: ("ANSWERED" | "UNDETECTED" | "ERROR" | "HUMAN_ANSWERED" | "SIT_TONE_DETECTED" | "SIT_TONE_BUSY" | "SIT_TONE_INVALID_NUMBER" | "FAX_MACHINE_DETECTED" | "VOICEMAIL_BEEP" | "VOICEMAIL_NO_BEEP" | "AMD_UNRESOLVED" | "AMD_UNANSWERED" | "AMD_ERROR" | "AMD_NOT_APPLICABLE")
|
625
644
|
attr_accessor customer_voice_activity: Types::CustomerVoiceActivity
|
626
645
|
attr_accessor quality_metrics: Types::QualityMetrics
|
646
|
+
attr_accessor chat_metrics: Types::ChatMetrics
|
627
647
|
attr_accessor disconnect_details: Types::DisconnectDetails
|
628
648
|
attr_accessor additional_email_recipients: Types::AdditionalEmailRecipients
|
629
649
|
attr_accessor segment_attributes: ::Hash[::String, Types::SegmentAttributeValue]
|
@@ -3932,6 +3952,19 @@ module Aws::Connect
|
|
3932
3952
|
SENSITIVE: []
|
3933
3953
|
end
|
3934
3954
|
|
3955
|
+
class ParticipantMetrics
|
3956
|
+
attr_accessor participant_id: ::String
|
3957
|
+
attr_accessor participant_type: ("ALL" | "MANAGER" | "AGENT" | "CUSTOMER" | "THIRDPARTY")
|
3958
|
+
attr_accessor conversation_abandon: bool
|
3959
|
+
attr_accessor messages_sent: ::Integer
|
3960
|
+
attr_accessor num_responses: ::Integer
|
3961
|
+
attr_accessor message_length_in_chars: ::Integer
|
3962
|
+
attr_accessor total_response_time_in_millis: ::Integer
|
3963
|
+
attr_accessor max_response_time_in_millis: ::Integer
|
3964
|
+
attr_accessor last_message_timestamp: ::Time
|
3965
|
+
SENSITIVE: []
|
3966
|
+
end
|
3967
|
+
|
3935
3968
|
class ParticipantTimerConfiguration
|
3936
3969
|
attr_accessor participant_role: ("CUSTOMER" | "AGENT")
|
3937
3970
|
attr_accessor timer_type: ("IDLE" | "DISCONNECT_NONCUSTOMER")
|