aws-sdk-connect 1.21.0 → 1.22.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +1 -1
- data/lib/aws-sdk-connect/client.rb +101 -7
- data/lib/aws-sdk-connect/client_api.rb +42 -0
- data/lib/aws-sdk-connect/types.rb +156 -5
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: de5e454354938356081edf1e3f2f72d92a94d7ee
|
4
|
+
data.tar.gz: 127ca153c8ca6cbb0c757c3c29627f72c837912a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 963271e4a66771e7ea0a3fd4315d1f96ec5d6163e62404c5cc57543098b985249439732cd9d4b425b84feda9f2898319ad857f6e365ebf2ba2bfa5ce13bae0b6
|
7
|
+
data.tar.gz: dcd3b8c1c44c037cba79a26bd3101c511f04b06936ca0a101d2e407dd533c0dbcaafdd0116c3b3fb5115025f6880f078865107c89e1db258441bcb80a708e24a
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -602,6 +602,10 @@ module Aws::Connect
|
|
602
602
|
#
|
603
603
|
# : Unit: COUNT
|
604
604
|
#
|
605
|
+
# AGENTS\_ON\_CONTACT
|
606
|
+
#
|
607
|
+
# : Unit: COUNT
|
608
|
+
#
|
605
609
|
# AGENTS\_ONLINE
|
606
610
|
#
|
607
611
|
# : Unit: COUNT
|
@@ -622,6 +626,14 @@ module Aws::Connect
|
|
622
626
|
#
|
623
627
|
# : Unit: SECONDS
|
624
628
|
#
|
629
|
+
# SLOTS\_ACTIVE
|
630
|
+
#
|
631
|
+
# : Unit: COUNT
|
632
|
+
#
|
633
|
+
# SLOTS\_AVAILABLE
|
634
|
+
#
|
635
|
+
# : Unit: COUNT
|
636
|
+
#
|
625
637
|
# @option params [String] :next_token
|
626
638
|
# The token for the next set of results. Use the value returned in the
|
627
639
|
# previous response in the next request to retrieve the next set of
|
@@ -646,12 +658,12 @@ module Aws::Connect
|
|
646
658
|
# instance_id: "InstanceId", # required
|
647
659
|
# filters: { # required
|
648
660
|
# queues: ["QueueId"],
|
649
|
-
# channels: ["VOICE"], # accepts VOICE
|
661
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
650
662
|
# },
|
651
663
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
652
664
|
# current_metrics: [ # required
|
653
665
|
# {
|
654
|
-
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED
|
666
|
+
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
655
667
|
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
656
668
|
# },
|
657
669
|
# ],
|
@@ -665,9 +677,9 @@ module Aws::Connect
|
|
665
677
|
# resp.metric_results #=> Array
|
666
678
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
667
679
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
668
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
|
680
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
669
681
|
# resp.metric_results[0].collections #=> Array
|
670
|
-
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED"
|
682
|
+
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE"
|
671
683
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
672
684
|
# resp.metric_results[0].collections[0].value #=> Float
|
673
685
|
# resp.data_snapshot_time #=> Time
|
@@ -940,7 +952,7 @@ module Aws::Connect
|
|
940
952
|
# end_time: Time.now, # required
|
941
953
|
# filters: { # required
|
942
954
|
# queues: ["QueueId"],
|
943
|
-
# channels: ["VOICE"], # accepts VOICE
|
955
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
944
956
|
# },
|
945
957
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
946
958
|
# historical_metrics: [ # required
|
@@ -964,7 +976,7 @@ module Aws::Connect
|
|
964
976
|
# resp.metric_results #=> Array
|
965
977
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
966
978
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
967
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
|
979
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
968
980
|
# resp.metric_results[0].collections #=> Array
|
969
981
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
|
970
982
|
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
@@ -1383,6 +1395,88 @@ module Aws::Connect
|
|
1383
1395
|
req.send_request(options)
|
1384
1396
|
end
|
1385
1397
|
|
1398
|
+
# Initiates a contact flow to start a new chat for the customer.
|
1399
|
+
# Response of this API provides a token required to obtain credentials
|
1400
|
+
# from the [CreateParticipantConnection][1] API in the Amazon Connect
|
1401
|
+
# Participant Service.
|
1402
|
+
#
|
1403
|
+
# When a new chat contact is successfully created, clients need to
|
1404
|
+
# subscribe to the participant’s connection for the created chat within
|
1405
|
+
# 5 minutes. This is achieved by invoking
|
1406
|
+
# [CreateParticipantConnection][1] with WEBSOCKET and
|
1407
|
+
# CONNECTION\_CREDENTIALS.
|
1408
|
+
#
|
1409
|
+
#
|
1410
|
+
#
|
1411
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
1412
|
+
#
|
1413
|
+
# @option params [required, String] :instance_id
|
1414
|
+
# The identifier of the Amazon Connect instance.
|
1415
|
+
#
|
1416
|
+
# @option params [required, String] :contact_flow_id
|
1417
|
+
# The identifier of the contact flow for the chat.
|
1418
|
+
#
|
1419
|
+
# @option params [Hash<String,String>] :attributes
|
1420
|
+
# A custom key-value pair using an attribute map. The attributes are
|
1421
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
1422
|
+
# flows just like any other contact attributes.
|
1423
|
+
#
|
1424
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
1425
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
1426
|
+
# underscore characters.
|
1427
|
+
#
|
1428
|
+
# @option params [required, Types::ParticipantDetails] :participant_details
|
1429
|
+
# Information identifying the participant.
|
1430
|
+
#
|
1431
|
+
# @option params [Types::ChatMessage] :initial_message
|
1432
|
+
# The initial message to be sent to the newly created chat.
|
1433
|
+
#
|
1434
|
+
# @option params [String] :client_token
|
1435
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1436
|
+
# idempotency of the request.
|
1437
|
+
#
|
1438
|
+
# **A suitable default value is auto-generated.** You should normally
|
1439
|
+
# not need to pass this option.**
|
1440
|
+
#
|
1441
|
+
# @return [Types::StartChatContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1442
|
+
#
|
1443
|
+
# * {Types::StartChatContactResponse#contact_id #contact_id} => String
|
1444
|
+
# * {Types::StartChatContactResponse#participant_id #participant_id} => String
|
1445
|
+
# * {Types::StartChatContactResponse#participant_token #participant_token} => String
|
1446
|
+
#
|
1447
|
+
# @example Request syntax with placeholder values
|
1448
|
+
#
|
1449
|
+
# resp = client.start_chat_contact({
|
1450
|
+
# instance_id: "InstanceId", # required
|
1451
|
+
# contact_flow_id: "ContactFlowId", # required
|
1452
|
+
# attributes: {
|
1453
|
+
# "AttributeName" => "AttributeValue",
|
1454
|
+
# },
|
1455
|
+
# participant_details: { # required
|
1456
|
+
# display_name: "DisplayName", # required
|
1457
|
+
# },
|
1458
|
+
# initial_message: {
|
1459
|
+
# content_type: "ChatContentType", # required
|
1460
|
+
# content: "ChatContent", # required
|
1461
|
+
# },
|
1462
|
+
# client_token: "ClientToken",
|
1463
|
+
# })
|
1464
|
+
#
|
1465
|
+
# @example Response structure
|
1466
|
+
#
|
1467
|
+
# resp.contact_id #=> String
|
1468
|
+
# resp.participant_id #=> String
|
1469
|
+
# resp.participant_token #=> String
|
1470
|
+
#
|
1471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContact AWS API Documentation
|
1472
|
+
#
|
1473
|
+
# @overload start_chat_contact(params = {})
|
1474
|
+
# @param [Hash] params ({})
|
1475
|
+
def start_chat_contact(params = {}, options = {})
|
1476
|
+
req = build_request(:start_chat_contact, params)
|
1477
|
+
req.send_request(options)
|
1478
|
+
end
|
1479
|
+
|
1386
1480
|
# Initiates a contact flow to place an outbound call to a customer.
|
1387
1481
|
#
|
1388
1482
|
# There is a 60 second dialing timeout for this operation. If the call
|
@@ -1772,7 +1866,7 @@ module Aws::Connect
|
|
1772
1866
|
params: params,
|
1773
1867
|
config: config)
|
1774
1868
|
context[:gem_name] = 'aws-sdk-connect'
|
1775
|
-
context[:gem_version] = '1.
|
1869
|
+
context[:gem_version] = '1.22.0'
|
1776
1870
|
Seahorse::Client::Request.new(handlers, context)
|
1777
1871
|
end
|
1778
1872
|
|
@@ -22,6 +22,9 @@ module Aws::Connect
|
|
22
22
|
AutoAccept = Shapes::BooleanShape.new(name: 'AutoAccept')
|
23
23
|
Channel = Shapes::StringShape.new(name: 'Channel')
|
24
24
|
Channels = Shapes::ListShape.new(name: 'Channels')
|
25
|
+
ChatContent = Shapes::StringShape.new(name: 'ChatContent')
|
26
|
+
ChatContentType = Shapes::StringShape.new(name: 'ChatContentType')
|
27
|
+
ChatMessage = Shapes::StructureShape.new(name: 'ChatMessage')
|
25
28
|
ClientToken = Shapes::StringShape.new(name: 'ClientToken')
|
26
29
|
Comparison = Shapes::StringShape.new(name: 'Comparison')
|
27
30
|
ContactFlowId = Shapes::StringShape.new(name: 'ContactFlowId')
|
@@ -52,6 +55,7 @@ module Aws::Connect
|
|
52
55
|
DestinationNotAllowedException = Shapes::StructureShape.new(name: 'DestinationNotAllowedException')
|
53
56
|
Dimensions = Shapes::StructureShape.new(name: 'Dimensions')
|
54
57
|
DirectoryUserId = Shapes::StringShape.new(name: 'DirectoryUserId')
|
58
|
+
DisplayName = Shapes::StringShape.new(name: 'DisplayName')
|
55
59
|
DuplicateResourceException = Shapes::StructureShape.new(name: 'DuplicateResourceException')
|
56
60
|
Email = Shapes::StringShape.new(name: 'Email')
|
57
61
|
Filters = Shapes::StructureShape.new(name: 'Filters')
|
@@ -114,6 +118,9 @@ module Aws::Connect
|
|
114
118
|
Message = Shapes::StringShape.new(name: 'Message')
|
115
119
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
116
120
|
OutboundContactNotPermittedException = Shapes::StructureShape.new(name: 'OutboundContactNotPermittedException')
|
121
|
+
ParticipantDetails = Shapes::StructureShape.new(name: 'ParticipantDetails')
|
122
|
+
ParticipantId = Shapes::StringShape.new(name: 'ParticipantId')
|
123
|
+
ParticipantToken = Shapes::StringShape.new(name: 'ParticipantToken')
|
117
124
|
Password = Shapes::StringShape.new(name: 'Password')
|
118
125
|
PhoneNumber = Shapes::StringShape.new(name: 'PhoneNumber')
|
119
126
|
PhoneNumberCountryCode = Shapes::StringShape.new(name: 'PhoneNumberCountryCode')
|
@@ -143,6 +150,8 @@ module Aws::Connect
|
|
143
150
|
SecurityProfileSummary = Shapes::StructureShape.new(name: 'SecurityProfileSummary')
|
144
151
|
SecurityProfileSummaryList = Shapes::ListShape.new(name: 'SecurityProfileSummaryList')
|
145
152
|
SecurityToken = Shapes::StringShape.new(name: 'SecurityToken')
|
153
|
+
StartChatContactRequest = Shapes::StructureShape.new(name: 'StartChatContactRequest')
|
154
|
+
StartChatContactResponse = Shapes::StructureShape.new(name: 'StartChatContactResponse')
|
146
155
|
StartOutboundVoiceContactRequest = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactRequest')
|
147
156
|
StartOutboundVoiceContactResponse = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactResponse')
|
148
157
|
Statistic = Shapes::StringShape.new(name: 'Statistic')
|
@@ -180,6 +189,10 @@ module Aws::Connect
|
|
180
189
|
|
181
190
|
Channels.member = Shapes::ShapeRef.new(shape: Channel)
|
182
191
|
|
192
|
+
ChatMessage.add_member(:content_type, Shapes::ShapeRef.new(shape: ChatContentType, required: true, location_name: "ContentType"))
|
193
|
+
ChatMessage.add_member(:content, Shapes::ShapeRef.new(shape: ChatContent, required: true, location_name: "Content"))
|
194
|
+
ChatMessage.struct_class = Types::ChatMessage
|
195
|
+
|
183
196
|
ContactFlowSummary.add_member(:id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "Id"))
|
184
197
|
ContactFlowSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
185
198
|
ContactFlowSummary.add_member(:name, Shapes::ShapeRef.new(shape: ContactFlowName, location_name: "Name"))
|
@@ -470,6 +483,9 @@ module Aws::Connect
|
|
470
483
|
OutboundContactNotPermittedException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
471
484
|
OutboundContactNotPermittedException.struct_class = Types::OutboundContactNotPermittedException
|
472
485
|
|
486
|
+
ParticipantDetails.add_member(:display_name, Shapes::ShapeRef.new(shape: DisplayName, required: true, location_name: "DisplayName"))
|
487
|
+
ParticipantDetails.struct_class = Types::ParticipantDetails
|
488
|
+
|
473
489
|
PhoneNumberCountryCodes.member = Shapes::ShapeRef.new(shape: PhoneNumberCountryCode)
|
474
490
|
|
475
491
|
PhoneNumberSummary.add_member(:id, Shapes::ShapeRef.new(shape: PhoneNumberId, location_name: "Id"))
|
@@ -518,6 +534,19 @@ module Aws::Connect
|
|
518
534
|
|
519
535
|
SecurityProfileSummaryList.member = Shapes::ShapeRef.new(shape: SecurityProfileSummary)
|
520
536
|
|
537
|
+
StartChatContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
538
|
+
StartChatContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId"))
|
539
|
+
StartChatContactRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
|
540
|
+
StartChatContactRequest.add_member(:participant_details, Shapes::ShapeRef.new(shape: ParticipantDetails, required: true, location_name: "ParticipantDetails"))
|
541
|
+
StartChatContactRequest.add_member(:initial_message, Shapes::ShapeRef.new(shape: ChatMessage, location_name: "InitialMessage"))
|
542
|
+
StartChatContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
543
|
+
StartChatContactRequest.struct_class = Types::StartChatContactRequest
|
544
|
+
|
545
|
+
StartChatContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
546
|
+
StartChatContactResponse.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, location_name: "ParticipantId"))
|
547
|
+
StartChatContactResponse.add_member(:participant_token, Shapes::ShapeRef.new(shape: ParticipantToken, location_name: "ParticipantToken"))
|
548
|
+
StartChatContactResponse.struct_class = Types::StartChatContactResponse
|
549
|
+
|
521
550
|
StartOutboundVoiceContactRequest.add_member(:destination_phone_number, Shapes::ShapeRef.new(shape: PhoneNumber, required: true, location_name: "DestinationPhoneNumber"))
|
522
551
|
StartOutboundVoiceContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId"))
|
523
552
|
StartOutboundVoiceContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
@@ -935,6 +964,19 @@ module Aws::Connect
|
|
935
964
|
)
|
936
965
|
end)
|
937
966
|
|
967
|
+
api.add_operation(:start_chat_contact, Seahorse::Model::Operation.new.tap do |o|
|
968
|
+
o.name = "StartChatContact"
|
969
|
+
o.http_method = "PUT"
|
970
|
+
o.http_request_uri = "/contact/chat"
|
971
|
+
o.input = Shapes::ShapeRef.new(shape: StartChatContactRequest)
|
972
|
+
o.output = Shapes::ShapeRef.new(shape: StartChatContactResponse)
|
973
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
974
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
975
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
976
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
977
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
978
|
+
end)
|
979
|
+
|
938
980
|
api.add_operation(:start_outbound_voice_contact, Seahorse::Model::Operation.new.tap do |o|
|
939
981
|
o.name = "StartOutboundVoiceContact"
|
940
982
|
o.http_method = "PUT"
|
@@ -8,6 +8,32 @@
|
|
8
8
|
module Aws::Connect
|
9
9
|
module Types
|
10
10
|
|
11
|
+
# A chat message.
|
12
|
+
#
|
13
|
+
# @note When making an API call, you may pass ChatMessage
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# content_type: "ChatContentType", # required
|
18
|
+
# content: "ChatContent", # required
|
19
|
+
# }
|
20
|
+
#
|
21
|
+
# @!attribute [rw] content_type
|
22
|
+
# The type of the content. Supported types are text/plain.
|
23
|
+
# @return [String]
|
24
|
+
#
|
25
|
+
# @!attribute [rw] content
|
26
|
+
# The content of the chat message.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ChatMessage AWS API Documentation
|
30
|
+
#
|
31
|
+
class ChatMessage < Struct.new(
|
32
|
+
:content_type,
|
33
|
+
:content)
|
34
|
+
include Aws::Structure
|
35
|
+
end
|
36
|
+
|
11
37
|
# Contains summary information about a contact flow.
|
12
38
|
#
|
13
39
|
# @!attribute [rw] id
|
@@ -201,7 +227,7 @@ module Aws::Connect
|
|
201
227
|
# data as a hash:
|
202
228
|
#
|
203
229
|
# {
|
204
|
-
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED
|
230
|
+
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
205
231
|
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
206
232
|
# }
|
207
233
|
#
|
@@ -430,7 +456,7 @@ module Aws::Connect
|
|
430
456
|
#
|
431
457
|
# {
|
432
458
|
# queues: ["QueueId"],
|
433
|
-
# channels: ["VOICE"], # accepts VOICE
|
459
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
434
460
|
# }
|
435
461
|
#
|
436
462
|
# @!attribute [rw] queues
|
@@ -492,12 +518,12 @@ module Aws::Connect
|
|
492
518
|
# instance_id: "InstanceId", # required
|
493
519
|
# filters: { # required
|
494
520
|
# queues: ["QueueId"],
|
495
|
-
# channels: ["VOICE"], # accepts VOICE
|
521
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
496
522
|
# },
|
497
523
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
498
524
|
# current_metrics: [ # required
|
499
525
|
# {
|
500
|
-
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED
|
526
|
+
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
501
527
|
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
502
528
|
# },
|
503
529
|
# ],
|
@@ -552,6 +578,10 @@ module Aws::Connect
|
|
552
578
|
#
|
553
579
|
# : Unit: COUNT
|
554
580
|
#
|
581
|
+
# AGENTS\_ON\_CONTACT
|
582
|
+
#
|
583
|
+
# : Unit: COUNT
|
584
|
+
#
|
555
585
|
# AGENTS\_ONLINE
|
556
586
|
#
|
557
587
|
# : Unit: COUNT
|
@@ -571,6 +601,14 @@ module Aws::Connect
|
|
571
601
|
# OLDEST\_CONTACT\_AGE
|
572
602
|
#
|
573
603
|
# : Unit: SECONDS
|
604
|
+
#
|
605
|
+
# SLOTS\_ACTIVE
|
606
|
+
#
|
607
|
+
# : Unit: COUNT
|
608
|
+
#
|
609
|
+
# SLOTS\_AVAILABLE
|
610
|
+
#
|
611
|
+
# : Unit: COUNT
|
574
612
|
# @return [Array<Types::CurrentMetric>]
|
575
613
|
#
|
576
614
|
# @!attribute [rw] next_token
|
@@ -664,7 +702,7 @@ module Aws::Connect
|
|
664
702
|
# end_time: Time.now, # required
|
665
703
|
# filters: { # required
|
666
704
|
# queues: ["QueueId"],
|
667
|
-
# channels: ["VOICE"], # accepts VOICE
|
705
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
668
706
|
# },
|
669
707
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
670
708
|
# historical_metrics: [ # required
|
@@ -1689,6 +1727,26 @@ module Aws::Connect
|
|
1689
1727
|
include Aws::Structure
|
1690
1728
|
end
|
1691
1729
|
|
1730
|
+
# The customer's details.
|
1731
|
+
#
|
1732
|
+
# @note When making an API call, you may pass ParticipantDetails
|
1733
|
+
# data as a hash:
|
1734
|
+
#
|
1735
|
+
# {
|
1736
|
+
# display_name: "DisplayName", # required
|
1737
|
+
# }
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] display_name
|
1740
|
+
# Display name of the participant.
|
1741
|
+
# @return [String]
|
1742
|
+
#
|
1743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantDetails AWS API Documentation
|
1744
|
+
#
|
1745
|
+
class ParticipantDetails < Struct.new(
|
1746
|
+
:display_name)
|
1747
|
+
include Aws::Structure
|
1748
|
+
end
|
1749
|
+
|
1692
1750
|
# Contains summary information about a phone number for a contact
|
1693
1751
|
# center.
|
1694
1752
|
#
|
@@ -1829,6 +1887,99 @@ module Aws::Connect
|
|
1829
1887
|
include Aws::Structure
|
1830
1888
|
end
|
1831
1889
|
|
1890
|
+
# @note When making an API call, you may pass StartChatContactRequest
|
1891
|
+
# data as a hash:
|
1892
|
+
#
|
1893
|
+
# {
|
1894
|
+
# instance_id: "InstanceId", # required
|
1895
|
+
# contact_flow_id: "ContactFlowId", # required
|
1896
|
+
# attributes: {
|
1897
|
+
# "AttributeName" => "AttributeValue",
|
1898
|
+
# },
|
1899
|
+
# participant_details: { # required
|
1900
|
+
# display_name: "DisplayName", # required
|
1901
|
+
# },
|
1902
|
+
# initial_message: {
|
1903
|
+
# content_type: "ChatContentType", # required
|
1904
|
+
# content: "ChatContent", # required
|
1905
|
+
# },
|
1906
|
+
# client_token: "ClientToken",
|
1907
|
+
# }
|
1908
|
+
#
|
1909
|
+
# @!attribute [rw] instance_id
|
1910
|
+
# The identifier of the Amazon Connect instance.
|
1911
|
+
# @return [String]
|
1912
|
+
#
|
1913
|
+
# @!attribute [rw] contact_flow_id
|
1914
|
+
# The identifier of the contact flow for the chat.
|
1915
|
+
# @return [String]
|
1916
|
+
#
|
1917
|
+
# @!attribute [rw] attributes
|
1918
|
+
# A custom key-value pair using an attribute map. The attributes are
|
1919
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
1920
|
+
# flows just like any other contact attributes.
|
1921
|
+
#
|
1922
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
1923
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
1924
|
+
# underscore characters.
|
1925
|
+
# @return [Hash<String,String>]
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] participant_details
|
1928
|
+
# Information identifying the participant.
|
1929
|
+
# @return [Types::ParticipantDetails]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] initial_message
|
1932
|
+
# The initial message to be sent to the newly created chat.
|
1933
|
+
# @return [Types::ChatMessage]
|
1934
|
+
#
|
1935
|
+
# @!attribute [rw] client_token
|
1936
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1937
|
+
# idempotency of the request.
|
1938
|
+
#
|
1939
|
+
# **A suitable default value is auto-generated.** You should normally
|
1940
|
+
# not need to pass this option.
|
1941
|
+
# @return [String]
|
1942
|
+
#
|
1943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactRequest AWS API Documentation
|
1944
|
+
#
|
1945
|
+
class StartChatContactRequest < Struct.new(
|
1946
|
+
:instance_id,
|
1947
|
+
:contact_flow_id,
|
1948
|
+
:attributes,
|
1949
|
+
:participant_details,
|
1950
|
+
:initial_message,
|
1951
|
+
:client_token)
|
1952
|
+
include Aws::Structure
|
1953
|
+
end
|
1954
|
+
|
1955
|
+
# @!attribute [rw] contact_id
|
1956
|
+
# The identifier of this contact within the Amazon Connect instance.
|
1957
|
+
# @return [String]
|
1958
|
+
#
|
1959
|
+
# @!attribute [rw] participant_id
|
1960
|
+
# The identifier for a chat participant. The participantId for a chat
|
1961
|
+
# participant is the same throughout the chat lifecycle.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] participant_token
|
1965
|
+
# The token used by the chat participant to call
|
1966
|
+
# [CreateParticipantConnection][1]. The participant token is valid for
|
1967
|
+
# the lifetime of a chat participant.
|
1968
|
+
#
|
1969
|
+
#
|
1970
|
+
#
|
1971
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
1972
|
+
# @return [String]
|
1973
|
+
#
|
1974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactResponse AWS API Documentation
|
1975
|
+
#
|
1976
|
+
class StartChatContactResponse < Struct.new(
|
1977
|
+
:contact_id,
|
1978
|
+
:participant_id,
|
1979
|
+
:participant_token)
|
1980
|
+
include Aws::Structure
|
1981
|
+
end
|
1982
|
+
|
1832
1983
|
# @note When making an API call, you may pass StartOutboundVoiceContactRequest
|
1833
1984
|
# data as a hash:
|
1834
1985
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.22.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-11-
|
11
|
+
date: 2019-11-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|