123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399 |
- {
- "version": "2.0",
- "metadata": {
- "apiVersion": "2018-09-07",
- "endpointPrefix": "participant.connect",
- "jsonVersion": "1.1",
- "protocol": "rest-json",
- "serviceAbbreviation": "Amazon Connect Participant",
- "serviceFullName": "Amazon Connect Participant Service",
- "serviceId": "ConnectParticipant",
- "signatureVersion": "v4",
- "signingName": "execute-api",
- "uid": "connectparticipant-2018-09-07"
- },
- "operations": {
- "CompleteAttachmentUpload": {
- "http": {
- "requestUri": "/participant/complete-attachment-upload"
- },
- "input": {
- "type": "structure",
- "required": [
- "AttachmentIds",
- "ClientToken",
- "ConnectionToken"
- ],
- "members": {
- "AttachmentIds": {
- "type": "list",
- "member": {}
- },
- "ClientToken": {
- "idempotencyToken": true
- },
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "CreateParticipantConnection": {
- "http": {
- "requestUri": "/participant/connection"
- },
- "input": {
- "type": "structure",
- "required": [
- "ParticipantToken"
- ],
- "members": {
- "Type": {
- "type": "list",
- "member": {}
- },
- "ParticipantToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- },
- "ConnectParticipant": {
- "type": "boolean"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "Websocket": {
- "type": "structure",
- "members": {
- "Url": {},
- "ConnectionExpiry": {}
- }
- },
- "ConnectionCredentials": {
- "type": "structure",
- "members": {
- "ConnectionToken": {},
- "Expiry": {}
- }
- }
- }
- }
- },
- "DescribeView": {
- "http": {
- "method": "GET",
- "requestUri": "/participant/views/{ViewToken}"
- },
- "input": {
- "type": "structure",
- "required": [
- "ViewToken",
- "ConnectionToken"
- ],
- "members": {
- "ViewToken": {
- "location": "uri",
- "locationName": "ViewToken"
- },
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "View": {
- "type": "structure",
- "members": {
- "Id": {},
- "Arn": {},
- "Name": {
- "type": "string",
- "sensitive": true
- },
- "Version": {
- "type": "integer"
- },
- "Content": {
- "type": "structure",
- "members": {
- "InputSchema": {
- "type": "string",
- "sensitive": true
- },
- "Template": {
- "type": "string",
- "sensitive": true
- },
- "Actions": {
- "type": "list",
- "member": {
- "type": "string",
- "sensitive": true
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "DisconnectParticipant": {
- "http": {
- "requestUri": "/participant/disconnect"
- },
- "input": {
- "type": "structure",
- "required": [
- "ConnectionToken"
- ],
- "members": {
- "ClientToken": {
- "idempotencyToken": true
- },
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "GetAttachment": {
- "http": {
- "requestUri": "/participant/attachment"
- },
- "input": {
- "type": "structure",
- "required": [
- "AttachmentId",
- "ConnectionToken"
- ],
- "members": {
- "AttachmentId": {},
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "Url": {},
- "UrlExpiry": {}
- }
- }
- },
- "GetTranscript": {
- "http": {
- "requestUri": "/participant/transcript"
- },
- "input": {
- "type": "structure",
- "required": [
- "ConnectionToken"
- ],
- "members": {
- "ContactId": {},
- "MaxResults": {
- "type": "integer"
- },
- "NextToken": {},
- "ScanDirection": {},
- "SortOrder": {},
- "StartPosition": {
- "type": "structure",
- "members": {
- "Id": {},
- "AbsoluteTime": {},
- "MostRecent": {
- "type": "integer"
- }
- }
- },
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "InitialContactId": {},
- "Transcript": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "AbsoluteTime": {},
- "Content": {},
- "ContentType": {},
- "Id": {},
- "Type": {},
- "ParticipantId": {},
- "DisplayName": {},
- "ParticipantRole": {},
- "Attachments": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "ContentType": {},
- "AttachmentId": {},
- "AttachmentName": {},
- "Status": {}
- }
- }
- },
- "MessageMetadata": {
- "type": "structure",
- "members": {
- "MessageId": {},
- "Receipts": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "DeliveredTimestamp": {},
- "ReadTimestamp": {},
- "RecipientParticipantId": {}
- }
- }
- }
- }
- },
- "RelatedContactId": {},
- "ContactId": {}
- }
- }
- },
- "NextToken": {}
- }
- }
- },
- "SendEvent": {
- "http": {
- "requestUri": "/participant/event"
- },
- "input": {
- "type": "structure",
- "required": [
- "ContentType",
- "ConnectionToken"
- ],
- "members": {
- "ContentType": {},
- "Content": {},
- "ClientToken": {
- "idempotencyToken": true
- },
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "Id": {},
- "AbsoluteTime": {}
- }
- }
- },
- "SendMessage": {
- "http": {
- "requestUri": "/participant/message"
- },
- "input": {
- "type": "structure",
- "required": [
- "ContentType",
- "Content",
- "ConnectionToken"
- ],
- "members": {
- "ContentType": {},
- "Content": {},
- "ClientToken": {
- "idempotencyToken": true
- },
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "Id": {},
- "AbsoluteTime": {}
- }
- }
- },
- "StartAttachmentUpload": {
- "http": {
- "requestUri": "/participant/start-attachment-upload"
- },
- "input": {
- "type": "structure",
- "required": [
- "ContentType",
- "AttachmentSizeInBytes",
- "AttachmentName",
- "ClientToken",
- "ConnectionToken"
- ],
- "members": {
- "ContentType": {},
- "AttachmentSizeInBytes": {
- "type": "long"
- },
- "AttachmentName": {},
- "ClientToken": {
- "idempotencyToken": true
- },
- "ConnectionToken": {
- "location": "header",
- "locationName": "X-Amz-Bearer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "AttachmentId": {},
- "UploadMetadata": {
- "type": "structure",
- "members": {
- "Url": {},
- "UrlExpiry": {},
- "HeadersToInclude": {
- "type": "map",
- "key": {},
- "value": {}
- }
- }
- }
- }
- }
- }
- },
- "shapes": {}
- }
|