participant service amazon connect · 2018. 9. 7. · amazon connect participant service api...
TRANSCRIPT
Amazon ConnectParticipant Service
API Reference
API Version 2018-09-07
Amazon Connect Participant Service API Reference
Amazon Connect Participant Service: API ReferenceCopyright © 2021 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.
Amazon Connect Participant Service API Reference
Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Working with the ACPS API ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Uploading attachments .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
CompleteAttachmentUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
CreateParticipantConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
DisconnectParticipant .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
GetAttachment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
GetTranscript ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
SendEvent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
SendMessage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
API Version 2018-09-07iii
Amazon Connect Participant Service API Reference
URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
StartAttachmentUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29AttachmentItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ConnectionCredentials ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Item ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
StartPosition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
UploadMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Websocket .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
API Version 2018-09-07iv
Amazon Connect Participant Service API Reference
WelcomeAmazon Connect is a cloud-based contact center solution that makes it easy to set up and manage acustomer contact center and provide reliable customer engagement at any scale.
Amazon Connect enables customer contacts through voice or chat.
The APIs described here are used by chat participants, such as agents and customers.
This document was last published on January 23, 2021.
API Version 2018-09-071
Amazon Connect Participant Service API ReferenceUploading attachments
Working with the Amazon ConnectParticipant Service API
This topic explains how to perform common tasks with the Amazon Connect Participant Service (ACPS)API.
Uploading attachmentsThere are three basic steps for uploading a file using the Amazon Connect Participant Service API.
1. HTTP POST file metadata to StartAttachmentUpload API, which will provide a signed Amazon S3URL and attachment ID for uploading the file directly to Amazon S3.
2. HTTP PUT file data to the signed Amazon S3 URL.3. HTTP POST attachment ID to CompleteAttachmentUpload to finalize the upload to Amazon S3.
Below is a basic JavaScript implementation for reference purposes.
//Define the html element for file using input tag
<input type="file" id="fileUpload"><input type="button" id="btnUploadFile" onclick="uploadFile()" value="Upload file">
async function uploadFile() { //Initiate the file upload by calling StartAttachmentUpload, providing the name, size, and content type of the file you want to upload. //The response will include a pre-signed URL and headers to use when building the file upload request, as well as an AttachmentId. const files = document.getElementById('fileUpload').files; const file = files[0];
const startUploadRequest = { AttachmentName: file.name, AttachmentSizeInBytes: file.size, ContentType: file.type };idid const { AttachmentId, UploadMetadata } = await startAttachmentUpload(startUploadRequest);
//Send the file data to the pre-signed S3 URL. //The file is stored in a temporary location in the S3 bucket.
await uploadFileToS3(file, UploadMetadata.Url, UploadMetadata.HeadersToInclude);
//Finalize the file upload by calling CompleteAttachmentUpload, providing the AttachmentId. //This moves the file to the final Attachments S3 path configured for the connect instance. const completeUploadRequest = { AttachmentIds: [ AttachmentId ] }; await completeAttachmentUpload(completeUploadRequest);}
API Version 2018-09-072
Amazon Connect Participant Service API ReferenceUploading attachments
async function startAttachmentUpload(requestData){ const response = await fetch(StartAttachmentUploadEndpoint, { method: 'POST', headers: { 'Content-Type': 'application/json' 'X-Amz-Bearer': ConnectionToken, }, body: JSON.stringify(requestData) });
return response.data;}
async function uploadFileToS3(file, signedUrl, headersToInclude) { return fetch(signedUrl, { method: 'PUT', headers: headersToInclude, body: file });}
async function completeAttachmentUpload(requestData){ return fetch(CompleteAttachmentUploadEndpoint, { method: 'POST', headers: { 'Content-Type': 'application/json' 'X-Amz-Bearer': ConnectionToken, }, body: JSON.stringify(requestData) });}
For an example of a real world implementation, view the Amazon Connect ChatJS JavaScript client onGitHub.
API Version 2018-09-073
Amazon Connect Participant Service API Reference
ActionsThe following actions are supported:
• CompleteAttachmentUpload (p. 5)• CreateParticipantConnection (p. 8)• DisconnectParticipant (p. 11)• GetAttachment (p. 13)• GetTranscript (p. 16)• SendEvent (p. 20)• SendMessage (p. 23)• StartAttachmentUpload (p. 26)
API Version 2018-09-074
Amazon Connect Participant Service API ReferenceCompleteAttachmentUpload
CompleteAttachmentUploadAllows you to confirm that the attachment has been uploaded using the pre-signed URL provided inStartAttachmentUpload API.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request SyntaxPOST /participant/complete-attachment-upload HTTP/1.1X-Amz-Bearer: ConnectionTokenContent-type: application/json
{ "AttachmentIds": [ "string" ], "ClientToken": "string"}
URI Request ParametersThe request uses the following URI parameters.
ConnectionToken (p. 5)
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
AttachmentIds (p. 5)
A list of unique identifiers for the attachments.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
ClientToken (p. 5)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
API Version 2018-09-075
Amazon Connect Participant Service API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403ConflictException
An attachment with that identifier is already being uploaded.
HTTP Status Code: 409InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500ServiceQuotaExceededException
The number of attachments per contact exceeds the quota.
HTTP Status Code: 402ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript
API Version 2018-09-076
Amazon Connect Participant Service API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-077
Amazon Connect Participant Service API ReferenceCreateParticipantConnection
CreateParticipantConnectionCreates the participant's connection. Note that ParticipantToken is used for invoking this API instead ofConnectionToken.
The participant token is valid for the lifetime of the participant – until they are part of a contact.
The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manuallyconnect to the returned websocket URL and subscribe to the desired topic.
For chat, you need to publish the following on the established websocket connection:
{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need tocall this API again to obtain a new websocket URL and perform the same steps as before.
NoteThe Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request SyntaxPOST /participant/connection HTTP/1.1X-Amz-Bearer: ParticipantTokenContent-type: application/json
{ "Type": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
ParticipantToken (p. 8)
This is a header parameter.
The Participant Token as obtained from StartChatContact API response.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Type (p. 8)
Type of connection information required.
Type: Array of strings
Array Members: Minimum number of 1 item.
Valid Values: WEBSOCKET | CONNECTION_CREDENTIALS
API Version 2018-09-078
Amazon Connect Participant Service API ReferenceResponse Syntax
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "ConnectionCredentials": { "ConnectionToken": "string", "Expiry": "string" }, "Websocket": { "ConnectionExpiry": "string", "Url": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ConnectionCredentials (p. 9)
Creates the participant's connection credentials. The authentication token associated with theparticipant's connection.
Type: ConnectionCredentials (p. 31) objectWebsocket (p. 9)
Creates the participant's websocket connection.
Type: Websocket (p. 36) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429
API Version 2018-09-079
Amazon Connect Participant Service API ReferenceSee Also
ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-0710
Amazon Connect Participant Service API ReferenceDisconnectParticipant
DisconnectParticipantDisconnects a participant. Note that ConnectionToken is used for invoking this API instead ofParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request Syntax
POST /participant/disconnect HTTP/1.1X-Amz-Bearer: ConnectionTokenContent-type: application/json
{ "ClientToken": "string"}
URI Request ParametersThe request uses the following URI parameters.
ConnectionToken (p. 11)
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
ClientToken (p. 11)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Maximum length of 500.
Required: No
Response Syntax
HTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
API Version 2018-09-0711
Amazon Connect Participant Service API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-0712
Amazon Connect Participant Service API ReferenceGetAttachment
GetAttachmentProvides a pre-signed URL for download of a completed attachment. This is an asynchronous API for usewith active contacts.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request Syntax
POST /participant/attachment HTTP/1.1X-Amz-Bearer: ConnectionTokenContent-type: application/json
{ "AttachmentId": "string"}
URI Request ParametersThe request uses the following URI parameters.
ConnectionToken (p. 13)
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
AttachmentId (p. 13)
A unique identifier for the attachment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "Url": "string", "UrlExpiry": "string"}
API Version 2018-09-0713
Amazon Connect Participant Service API ReferenceResponse Elements
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Url (p. 13)
This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used inresponse to StartAttachmentUpload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.UrlExpiry (p. 13)
The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2
API Version 2018-09-0714
Amazon Connect Participant Service API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-0715
Amazon Connect Participant Service API ReferenceGetTranscript
GetTranscriptRetrieves a transcript of the session, including details about any attachments. Note thatConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request SyntaxPOST /participant/transcript HTTP/1.1X-Amz-Bearer: ConnectionTokenContent-type: application/json
{ "ContactId": "string", "MaxResults": number, "NextToken": "string", "ScanDirection": "string", "SortOrder": "string", "StartPosition": { "AbsoluteTime": "string", "Id": "string", "MostRecent": number }}
URI Request ParametersThe request uses the following URI parameters.
ConnectionToken (p. 16)
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
ContactId (p. 16)
The contactId from the current contact chain for which transcript is needed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoMaxResults (p. 16)
The maximum number of results to return in the page. Default: 10.
Type: Integer
API Version 2018-09-0716
Amazon Connect Participant Service API ReferenceResponse Syntax
Valid Range: Minimum value of 0. Maximum value of 100.
Required: NoNextToken (p. 16)
The pagination token. Use the value returned previously in the next subsequent request to retrievethe next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: NoScanDirection (p. 16)
The direction from StartPosition from which to retrieve message. Default: BACKWARD when noStartPosition is provided, FORWARD with StartPosition.
Type: String
Valid Values: FORWARD | BACKWARD
Required: NoSortOrder (p. 16)
The sort order for the records. Default: DESCENDING.
Type: String
Valid Values: DESCENDING | ASCENDING
Required: NoStartPosition (p. 16)
A filtering option for where to start.
Type: StartPosition (p. 34) object
Required: No
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "InitialContactId": "string", "NextToken": "string", "Transcript": [ { "AbsoluteTime": "string", "Attachments": [ { "AttachmentId": "string", "AttachmentName": "string", "ContentType": "string", "Status": "string" } ],
API Version 2018-09-0717
Amazon Connect Participant Service API ReferenceResponse Elements
"Content": "string", "ContentType": "string", "DisplayName": "string", "Id": "string", "ParticipantId": "string", "ParticipantRole": "string", "Type": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
InitialContactId (p. 17)
The initial contact ID for the contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.NextToken (p. 17)
The pagination token. Use the value returned previously in the next subsequent request to retrievethe next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.Transcript (p. 17)
The list of messages in the session.
Type: Array of Item (p. 32) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429
API Version 2018-09-0718
Amazon Connect Participant Service API ReferenceSee Also
ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-0719
Amazon Connect Participant Service API ReferenceSendEvent
SendEventSends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request SyntaxPOST /participant/event HTTP/1.1X-Amz-Bearer: ConnectionTokenContent-type: application/json
{ "ClientToken": "string", "Content": "string", "ContentType": "string"}
URI Request ParametersThe request uses the following URI parameters.
ConnectionToken (p. 20)
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
ClientToken (p. 20)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Maximum length of 500.
Required: NoContent (p. 20)
The content of the event to be sent (for example, message text). This is not yet supported.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: NoContentType (p. 20)
The content type of the request. Supported types are:• application/vnd.amazonaws.connect.event.typing
API Version 2018-09-0720
Amazon Connect Participant Service API ReferenceResponse Syntax
• application/vnd.amazonaws.connect.event.connection.acknowledged
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "AbsoluteTime": "string", "Id": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AbsoluteTime (p. 21)
The time when the event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,2019-11-08T02:41:28.172Z.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.Id (p. 21)
The ID of the response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500
API Version 2018-09-0721
Amazon Connect Participant Service API ReferenceSee Also
ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-0722
Amazon Connect Participant Service API ReferenceSendMessage
SendMessageSends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request SyntaxPOST /participant/message HTTP/1.1X-Amz-Bearer: ConnectionTokenContent-type: application/json
{ "ClientToken": "string", "Content": "string", "ContentType": "string"}
URI Request ParametersThe request uses the following URI parameters.
ConnectionToken (p. 23)
The authentication token associated with the connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
ClientToken (p. 23)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Maximum length of 500.
Required: NoContent (p. 23)
The content of the message.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: YesContentType (p. 23)
The type of the content. Supported types are text/plain.
Type: String
API Version 2018-09-0723
Amazon Connect Participant Service API ReferenceResponse Syntax
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "AbsoluteTime": "string", "Id": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AbsoluteTime (p. 24)
The time when the message was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,2019-11-08T02:41:28.172Z.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.Id (p. 24)
The ID of the message.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500ThrottlingException
The request was denied due to request throttling.
API Version 2018-09-0724
Amazon Connect Participant Service API ReferenceSee Also
HTTP Status Code: 429ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-0725
Amazon Connect Participant Service API ReferenceStartAttachmentUpload
StartAttachmentUploadProvides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request SyntaxPOST /participant/start-attachment-upload HTTP/1.1X-Amz-Bearer: ConnectionTokenContent-type: application/json
{ "AttachmentName": "string", "AttachmentSizeInBytes": number, "ClientToken": "string", "ContentType": "string"}
URI Request ParametersThe request uses the following URI parameters.
ConnectionToken (p. 26)
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
AttachmentName (p. 26)
A case-sensitive name of the attachment being uploaded.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: YesAttachmentSizeInBytes (p. 26)
The size of the attachment in bytes.
Type: Long
Valid Range: Minimum value of 1.
Required: YesClientToken (p. 26)
A unique case sensitive identifier to support idempotency of request.
API Version 2018-09-0726
Amazon Connect Participant Service API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: YesContentType (p. 26)
Describes the MIME file type of the attachment. For a list of supported file types, see Featurespecifications in the Amazon Connect Administrator Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "AttachmentId": "string", "UploadMetadata": { "HeadersToInclude": { "string" : "string" }, "Url": "string", "UrlExpiry": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AttachmentId (p. 27)
A unique identifier for the attachment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.UploadMetadata (p. 27)
Fields to be used while uploading the attachment.
Type: UploadMetadata (p. 35) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 39).
AccessDeniedException
You do not have sufficient access to perform this action.
API Version 2018-09-0727
Amazon Connect Participant Service API ReferenceSee Also
HTTP Status Code: 403InternalServerException
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500ServiceQuotaExceededException
The number of attachments per contact exceeds the quota.
HTTP Status Code: 402ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429ValidationException
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-09-0728
Amazon Connect Participant Service API Reference
Data TypesThe Amazon Connect Participant Service API contains several data types that various actions use. Thissection describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.
The following data types are supported:
• AttachmentItem (p. 30)• ConnectionCredentials (p. 31)• Item (p. 32)• StartPosition (p. 34)• UploadMetadata (p. 35)• Websocket (p. 36)
API Version 2018-09-0729
Amazon Connect Participant Service API ReferenceAttachmentItem
AttachmentItemThe case-insensitive input to indicate standard MIME type that describes the format of the file that willbe uploaded.
ContentsAttachmentId
A unique identifier for the attachment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoAttachmentName
A case-sensitive name of the attachment being uploaded.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoContentType
Describes the MIME file type of the attachment. For a list of supported file types, see Featurespecifications in the Amazon Connect Administrator Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: NoStatus
Status of the attachment.
Type: String
Valid Values: APPROVED | REJECTED | IN_PROGRESS
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2018-09-0730
Amazon Connect Participant Service API ReferenceConnectionCredentials
ConnectionCredentialsConnection credentials.
ContentsConnectionToken
The connection token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: NoExpiry
The expiration of the token.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,2019-11-08T02:41:28.172Z.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2018-09-0731
Amazon Connect Participant Service API ReferenceItem
ItemAn item - message or event - that has been sent.
ContentsAbsoluteTime
The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,2019-11-08T02:41:28.172Z.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: NoAttachments
Provides information about the attachments.
Type: Array of AttachmentItem (p. 30) objects
Required: NoContent
The content of the message or event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: NoContentType
The type of content of the item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: NoDisplayName
The chat display name of the sender.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoId
The ID of the item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
API Version 2018-09-0732
Amazon Connect Participant Service API ReferenceSee Also
Required: NoParticipantId
The ID of the sender in the session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoParticipantRole
The role of the sender. For example, is it a customer, agent, or system.
Type: String
Valid Values: AGENT | CUSTOMER | SYSTEM
Required: NoType
Type of the item: message or event.
Type: String
Valid Values: TYPING | PARTICIPANT_JOINED | PARTICIPANT_LEFT | CHAT_ENDED| TRANSFER_SUCCEEDED | TRANSFER_FAILED | MESSAGE | EVENT | ATTACHMENT |CONNECTION_ACK
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2018-09-0733
Amazon Connect Participant Service API ReferenceStartPosition
StartPositionA filtering option for where to start. For example, if you sent 100 messages, start with message 50.
ContentsAbsoluteTime
The time in ISO format where to start.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,2019-11-08T02:41:28.172Z.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: NoId
The ID of the message or event where to start.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoMostRecent
The start position of the most recent message where you want to start.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2018-09-0734
Amazon Connect Participant Service API ReferenceUploadMetadata
UploadMetadataFields to be used while uploading the attachment.
ContentsHeadersToInclude
The headers to be provided while uploading the file to the URL.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoUrl
This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used inresponse to StartAttachmentUpload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: NoUrlExpiry
The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2018-09-0735
Amazon Connect Participant Service API ReferenceWebsocket
WebsocketThe websocket for the participant's connection.
ContentsConnectionExpiry
The URL expiration timestamp in ISO date format.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,2019-11-08T02:41:28.172Z.
Type: String
Required: NoUrl
The URL of the websocket.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2018-09-0736
Amazon Connect Participant Service API Reference
Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.
Action
The action to be performed.
Type: string
Required: YesVersion
The API version that the request is written for, expressed in the format YYYY-MM-DD.
Type: string
Required: YesX-Amz-Algorithm
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Valid Values: AWS4-HMAC-SHA256
Required: ConditionalX-Amz-Credential
The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.
For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-Date
The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is
API Version 2018-09-0737
Amazon Connect Participant Service API Reference
not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.
Type: string
Required: ConditionalX-Amz-Security-Token
The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.
Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.
Type: string
Required: ConditionalX-Amz-Signature
Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-SignedHeaders
Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: Conditional
API Version 2018-09-0738
Amazon Connect Participant Service API Reference
Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 400IncompleteSignature
The request signature does not conform to AWS standards.
HTTP Status Code: 400InternalFailure
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500InvalidAction
The action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400InvalidClientTokenId
The X.509 certificate or AWS access key ID provided does not exist in our records.
HTTP Status Code: 403InvalidParameterCombination
Parameters that must not be used together were used together.
HTTP Status Code: 400InvalidParameterValue
An invalid or out-of-range value was supplied for the input parameter.
HTTP Status Code: 400InvalidQueryParameter
The AWS query string is malformed or does not adhere to AWS standards.
HTTP Status Code: 400MalformedQueryString
The query string contains a syntax error.
HTTP Status Code: 404MissingAction
The request is missing an action or a required parameter.
HTTP Status Code: 400
API Version 2018-09-0739
Amazon Connect Participant Service API Reference
MissingAuthenticationToken
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 403MissingParameter
A required parameter for the specified action is not supplied.
HTTP Status Code: 400NotAuthorized
You do not have permission to perform this action.
HTTP Status Code: 400OptInRequired
The AWS access key ID needs a subscription for the service.
HTTP Status Code: 403RequestExpired
The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.
HTTP Status Code: 400ServiceUnavailable
The request has failed due to a temporary failure of the server.
HTTP Status Code: 503ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400ValidationError
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
API Version 2018-09-0740