1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2018-09-07", 5 "endpointPrefix":"participant.connect", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceAbbreviation":"Amazon Connect Participant", 9 "serviceFullName":"Amazon Connect Participant Service", 10 "serviceId":"ConnectParticipant", 11 "signatureVersion":"v4", 12 "signingName":"execute-api", 13 "uid":"connectparticipant-2018-09-07" 14 }, 15 "operations":{ 16 "CompleteAttachmentUpload":{ 17 "name":"CompleteAttachmentUpload", 18 "http":{ 19 "method":"POST", 20 "requestUri":"/participant/complete-attachment-upload" 21 }, 22 "input":{"shape":"CompleteAttachmentUploadRequest"}, 23 "output":{"shape":"CompleteAttachmentUploadResponse"}, 24 "errors":[ 25 {"shape":"AccessDeniedException"}, 26 {"shape":"InternalServerException"}, 27 {"shape":"ThrottlingException"}, 28 {"shape":"ValidationException"}, 29 {"shape":"ServiceQuotaExceededException"}, 30 {"shape":"ConflictException"} 31 ] 32 }, 33 "CreateParticipantConnection":{ 34 "name":"CreateParticipantConnection", 35 "http":{ 36 "method":"POST", 37 "requestUri":"/participant/connection" 38 }, 39 "input":{"shape":"CreateParticipantConnectionRequest"}, 40 "output":{"shape":"CreateParticipantConnectionResponse"}, 41 "errors":[ 42 {"shape":"AccessDeniedException"}, 43 {"shape":"InternalServerException"}, 44 {"shape":"ThrottlingException"}, 45 {"shape":"ValidationException"} 46 ] 47 }, 48 "DisconnectParticipant":{ 49 "name":"DisconnectParticipant", 50 "http":{ 51 "method":"POST", 52 "requestUri":"/participant/disconnect" 53 }, 54 "input":{"shape":"DisconnectParticipantRequest"}, 55 "output":{"shape":"DisconnectParticipantResponse"}, 56 "errors":[ 57 {"shape":"AccessDeniedException"}, 58 {"shape":"InternalServerException"}, 59 {"shape":"ThrottlingException"}, 60 {"shape":"ValidationException"} 61 ] 62 }, 63 "GetAttachment":{ 64 "name":"GetAttachment", 65 "http":{ 66 "method":"POST", 67 "requestUri":"/participant/attachment" 68 }, 69 "input":{"shape":"GetAttachmentRequest"}, 70 "output":{"shape":"GetAttachmentResponse"}, 71 "errors":[ 72 {"shape":"AccessDeniedException"}, 73 {"shape":"InternalServerException"}, 74 {"shape":"ThrottlingException"}, 75 {"shape":"ValidationException"} 76 ] 77 }, 78 "GetTranscript":{ 79 "name":"GetTranscript", 80 "http":{ 81 "method":"POST", 82 "requestUri":"/participant/transcript" 83 }, 84 "input":{"shape":"GetTranscriptRequest"}, 85 "output":{"shape":"GetTranscriptResponse"}, 86 "errors":[ 87 {"shape":"AccessDeniedException"}, 88 {"shape":"InternalServerException"}, 89 {"shape":"ThrottlingException"}, 90 {"shape":"ValidationException"} 91 ] 92 }, 93 "SendEvent":{ 94 "name":"SendEvent", 95 "http":{ 96 "method":"POST", 97 "requestUri":"/participant/event" 98 }, 99 "input":{"shape":"SendEventRequest"}, 100 "output":{"shape":"SendEventResponse"}, 101 "errors":[ 102 {"shape":"AccessDeniedException"}, 103 {"shape":"InternalServerException"}, 104 {"shape":"ThrottlingException"}, 105 {"shape":"ValidationException"} 106 ] 107 }, 108 "SendMessage":{ 109 "name":"SendMessage", 110 "http":{ 111 "method":"POST", 112 "requestUri":"/participant/message" 113 }, 114 "input":{"shape":"SendMessageRequest"}, 115 "output":{"shape":"SendMessageResponse"}, 116 "errors":[ 117 {"shape":"AccessDeniedException"}, 118 {"shape":"InternalServerException"}, 119 {"shape":"ThrottlingException"}, 120 {"shape":"ValidationException"} 121 ] 122 }, 123 "StartAttachmentUpload":{ 124 "name":"StartAttachmentUpload", 125 "http":{ 126 "method":"POST", 127 "requestUri":"/participant/start-attachment-upload" 128 }, 129 "input":{"shape":"StartAttachmentUploadRequest"}, 130 "output":{"shape":"StartAttachmentUploadResponse"}, 131 "errors":[ 132 {"shape":"AccessDeniedException"}, 133 {"shape":"InternalServerException"}, 134 {"shape":"ThrottlingException"}, 135 {"shape":"ValidationException"}, 136 {"shape":"ServiceQuotaExceededException"} 137 ] 138 } 139 }, 140 "shapes":{ 141 "AccessDeniedException":{ 142 "type":"structure", 143 "required":["Message"], 144 "members":{ 145 "Message":{"shape":"Message"} 146 }, 147 "error":{"httpStatusCode":403}, 148 "exception":true 149 }, 150 "ArtifactId":{ 151 "type":"string", 152 "max":256, 153 "min":1 154 }, 155 "ArtifactStatus":{ 156 "type":"string", 157 "enum":[ 158 "APPROVED", 159 "REJECTED", 160 "IN_PROGRESS" 161 ] 162 }, 163 "AttachmentIdList":{ 164 "type":"list", 165 "member":{"shape":"ArtifactId"}, 166 "max":1, 167 "min":1 168 }, 169 "AttachmentItem":{ 170 "type":"structure", 171 "members":{ 172 "ContentType":{"shape":"ContentType"}, 173 "AttachmentId":{"shape":"ArtifactId"}, 174 "AttachmentName":{"shape":"AttachmentName"}, 175 "Status":{"shape":"ArtifactStatus"} 176 } 177 }, 178 "AttachmentName":{ 179 "type":"string", 180 "max":256, 181 "min":1 182 }, 183 "AttachmentSizeInBytes":{ 184 "type":"long", 185 "min":1 186 }, 187 "Attachments":{ 188 "type":"list", 189 "member":{"shape":"AttachmentItem"} 190 }, 191 "Bool":{"type":"boolean"}, 192 "ChatContent":{ 193 "type":"string", 194 "max":1024, 195 "min":1 196 }, 197 "ChatContentType":{ 198 "type":"string", 199 "max":100, 200 "min":1 201 }, 202 "ChatItemId":{ 203 "type":"string", 204 "max":256, 205 "min":1 206 }, 207 "ChatItemType":{ 208 "type":"string", 209 "enum":[ 210 "TYPING", 211 "PARTICIPANT_JOINED", 212 "PARTICIPANT_LEFT", 213 "CHAT_ENDED", 214 "TRANSFER_SUCCEEDED", 215 "TRANSFER_FAILED", 216 "MESSAGE", 217 "EVENT", 218 "ATTACHMENT", 219 "CONNECTION_ACK", 220 "PARTICIPANT_ACTIVE", 221 "PARTICIPANT_INACTIVE", 222 "PARTICIPANT_ENGAGED", 223 "PARTICIPANT_DISENGAGED" 224 ] 225 }, 226 "ClientToken":{ 227 "type":"string", 228 "max":500 229 }, 230 "CompleteAttachmentUploadRequest":{ 231 "type":"structure", 232 "required":[ 233 "AttachmentIds", 234 "ClientToken", 235 "ConnectionToken" 236 ], 237 "members":{ 238 "AttachmentIds":{"shape":"AttachmentIdList"}, 239 "ClientToken":{ 240 "shape":"NonEmptyClientToken", 241 "idempotencyToken":true 242 }, 243 "ConnectionToken":{ 244 "shape":"ParticipantToken", 245 "location":"header", 246 "locationName":"X-Amz-Bearer" 247 } 248 } 249 }, 250 "CompleteAttachmentUploadResponse":{ 251 "type":"structure", 252 "members":{ 253 } 254 }, 255 "ConflictException":{ 256 "type":"structure", 257 "required":["Message"], 258 "members":{ 259 "Message":{"shape":"Reason"} 260 }, 261 "error":{"httpStatusCode":409}, 262 "exception":true 263 }, 264 "ConnectionCredentials":{ 265 "type":"structure", 266 "members":{ 267 "ConnectionToken":{"shape":"ParticipantToken"}, 268 "Expiry":{"shape":"ISO8601Datetime"} 269 } 270 }, 271 "ConnectionType":{ 272 "type":"string", 273 "enum":[ 274 "WEBSOCKET", 275 "CONNECTION_CREDENTIALS" 276 ] 277 }, 278 "ConnectionTypeList":{ 279 "type":"list", 280 "member":{"shape":"ConnectionType"}, 281 "min":1 282 }, 283 "ContactId":{ 284 "type":"string", 285 "max":256, 286 "min":1 287 }, 288 "ContentType":{ 289 "type":"string", 290 "max":255, 291 "min":1 292 }, 293 "CreateParticipantConnectionRequest":{ 294 "type":"structure", 295 "required":[ 296 "Type", 297 "ParticipantToken" 298 ], 299 "members":{ 300 "Type":{"shape":"ConnectionTypeList"}, 301 "ParticipantToken":{ 302 "shape":"ParticipantToken", 303 "location":"header", 304 "locationName":"X-Amz-Bearer" 305 }, 306 "ConnectParticipant":{"shape":"Bool"} 307 } 308 }, 309 "CreateParticipantConnectionResponse":{ 310 "type":"structure", 311 "members":{ 312 "Websocket":{"shape":"Websocket"}, 313 "ConnectionCredentials":{"shape":"ConnectionCredentials"} 314 } 315 }, 316 "DisconnectParticipantRequest":{ 317 "type":"structure", 318 "required":["ConnectionToken"], 319 "members":{ 320 "ClientToken":{ 321 "shape":"ClientToken", 322 "idempotencyToken":true 323 }, 324 "ConnectionToken":{ 325 "shape":"ParticipantToken", 326 "location":"header", 327 "locationName":"X-Amz-Bearer" 328 } 329 } 330 }, 331 "DisconnectParticipantResponse":{ 332 "type":"structure", 333 "members":{ 334 } 335 }, 336 "DisplayName":{ 337 "type":"string", 338 "max":256, 339 "min":1 340 }, 341 "GetAttachmentRequest":{ 342 "type":"structure", 343 "required":[ 344 "AttachmentId", 345 "ConnectionToken" 346 ], 347 "members":{ 348 "AttachmentId":{"shape":"ArtifactId"}, 349 "ConnectionToken":{ 350 "shape":"ParticipantToken", 351 "location":"header", 352 "locationName":"X-Amz-Bearer" 353 } 354 } 355 }, 356 "GetAttachmentResponse":{ 357 "type":"structure", 358 "members":{ 359 "Url":{"shape":"PreSignedAttachmentUrl"}, 360 "UrlExpiry":{"shape":"ISO8601Datetime"} 361 } 362 }, 363 "GetTranscriptRequest":{ 364 "type":"structure", 365 "required":["ConnectionToken"], 366 "members":{ 367 "ContactId":{"shape":"ContactId"}, 368 "MaxResults":{ 369 "shape":"MaxResults", 370 "box":true 371 }, 372 "NextToken":{"shape":"NextToken"}, 373 "ScanDirection":{"shape":"ScanDirection"}, 374 "SortOrder":{"shape":"SortKey"}, 375 "StartPosition":{"shape":"StartPosition"}, 376 "ConnectionToken":{ 377 "shape":"ParticipantToken", 378 "location":"header", 379 "locationName":"X-Amz-Bearer" 380 } 381 } 382 }, 383 "GetTranscriptResponse":{ 384 "type":"structure", 385 "members":{ 386 "InitialContactId":{"shape":"ContactId"}, 387 "Transcript":{"shape":"Transcript"}, 388 "NextToken":{"shape":"NextToken"} 389 } 390 }, 391 "ISO8601Datetime":{"type":"string"}, 392 "Instant":{ 393 "type":"string", 394 "max":100, 395 "min":1 396 }, 397 "InternalServerException":{ 398 "type":"structure", 399 "required":["Message"], 400 "members":{ 401 "Message":{"shape":"Message"} 402 }, 403 "error":{"httpStatusCode":500}, 404 "exception":true, 405 "fault":true 406 }, 407 "Item":{ 408 "type":"structure", 409 "members":{ 410 "AbsoluteTime":{"shape":"Instant"}, 411 "Content":{"shape":"ChatContent"}, 412 "ContentType":{"shape":"ChatContentType"}, 413 "Id":{"shape":"ChatItemId"}, 414 "Type":{"shape":"ChatItemType"}, 415 "ParticipantId":{"shape":"ParticipantId"}, 416 "DisplayName":{"shape":"DisplayName"}, 417 "ParticipantRole":{"shape":"ParticipantRole"}, 418 "Attachments":{"shape":"Attachments"} 419 } 420 }, 421 "MaxResults":{ 422 "type":"integer", 423 "max":100, 424 "min":0 425 }, 426 "Message":{"type":"string"}, 427 "MostRecent":{ 428 "type":"integer", 429 "max":100, 430 "min":0 431 }, 432 "NextToken":{ 433 "type":"string", 434 "max":1000, 435 "min":1 436 }, 437 "NonEmptyClientToken":{ 438 "type":"string", 439 "max":500, 440 "min":1 441 }, 442 "ParticipantId":{ 443 "type":"string", 444 "max":256, 445 "min":1 446 }, 447 "ParticipantRole":{ 448 "type":"string", 449 "enum":[ 450 "AGENT", 451 "CUSTOMER", 452 "SYSTEM" 453 ] 454 }, 455 "ParticipantToken":{ 456 "type":"string", 457 "max":1000, 458 "min":1 459 }, 460 "PreSignedAttachmentUrl":{ 461 "type":"string", 462 "max":2000, 463 "min":1 464 }, 465 "PreSignedConnectionUrl":{ 466 "type":"string", 467 "max":2000, 468 "min":1 469 }, 470 "Reason":{ 471 "type":"string", 472 "max":2000, 473 "min":1 474 }, 475 "ScanDirection":{ 476 "type":"string", 477 "enum":[ 478 "FORWARD", 479 "BACKWARD" 480 ] 481 }, 482 "SendEventRequest":{ 483 "type":"structure", 484 "required":[ 485 "ContentType", 486 "ConnectionToken" 487 ], 488 "members":{ 489 "ContentType":{"shape":"ChatContentType"}, 490 "Content":{"shape":"ChatContent"}, 491 "ClientToken":{ 492 "shape":"ClientToken", 493 "idempotencyToken":true 494 }, 495 "ConnectionToken":{ 496 "shape":"ParticipantToken", 497 "location":"header", 498 "locationName":"X-Amz-Bearer" 499 } 500 } 501 }, 502 "SendEventResponse":{ 503 "type":"structure", 504 "members":{ 505 "Id":{"shape":"ChatItemId"}, 506 "AbsoluteTime":{"shape":"Instant"} 507 } 508 }, 509 "SendMessageRequest":{ 510 "type":"structure", 511 "required":[ 512 "ContentType", 513 "Content", 514 "ConnectionToken" 515 ], 516 "members":{ 517 "ContentType":{"shape":"ChatContentType"}, 518 "Content":{"shape":"ChatContent"}, 519 "ClientToken":{ 520 "shape":"ClientToken", 521 "idempotencyToken":true 522 }, 523 "ConnectionToken":{ 524 "shape":"ParticipantToken", 525 "location":"header", 526 "locationName":"X-Amz-Bearer" 527 } 528 } 529 }, 530 "SendMessageResponse":{ 531 "type":"structure", 532 "members":{ 533 "Id":{"shape":"ChatItemId"}, 534 "AbsoluteTime":{"shape":"Instant"} 535 } 536 }, 537 "ServiceQuotaExceededException":{ 538 "type":"structure", 539 "required":["Message"], 540 "members":{ 541 "Message":{"shape":"Message"} 542 }, 543 "error":{"httpStatusCode":402}, 544 "exception":true 545 }, 546 "SortKey":{ 547 "type":"string", 548 "enum":[ 549 "DESCENDING", 550 "ASCENDING" 551 ] 552 }, 553 "StartAttachmentUploadRequest":{ 554 "type":"structure", 555 "required":[ 556 "ContentType", 557 "AttachmentSizeInBytes", 558 "AttachmentName", 559 "ClientToken", 560 "ConnectionToken" 561 ], 562 "members":{ 563 "ContentType":{"shape":"ContentType"}, 564 "AttachmentSizeInBytes":{"shape":"AttachmentSizeInBytes"}, 565 "AttachmentName":{"shape":"AttachmentName"}, 566 "ClientToken":{ 567 "shape":"NonEmptyClientToken", 568 "idempotencyToken":true 569 }, 570 "ConnectionToken":{ 571 "shape":"ParticipantToken", 572 "location":"header", 573 "locationName":"X-Amz-Bearer" 574 } 575 } 576 }, 577 "StartAttachmentUploadResponse":{ 578 "type":"structure", 579 "members":{ 580 "AttachmentId":{"shape":"ArtifactId"}, 581 "UploadMetadata":{"shape":"UploadMetadata"} 582 } 583 }, 584 "StartPosition":{ 585 "type":"structure", 586 "members":{ 587 "Id":{"shape":"ChatItemId"}, 588 "AbsoluteTime":{"shape":"Instant"}, 589 "MostRecent":{"shape":"MostRecent"} 590 } 591 }, 592 "ThrottlingException":{ 593 "type":"structure", 594 "required":["Message"], 595 "members":{ 596 "Message":{"shape":"Message"} 597 }, 598 "error":{"httpStatusCode":429}, 599 "exception":true 600 }, 601 "Transcript":{ 602 "type":"list", 603 "member":{"shape":"Item"} 604 }, 605 "UploadMetadata":{ 606 "type":"structure", 607 "members":{ 608 "Url":{"shape":"UploadMetadataUrl"}, 609 "UrlExpiry":{"shape":"ISO8601Datetime"}, 610 "HeadersToInclude":{"shape":"UploadMetadataSignedHeaders"} 611 } 612 }, 613 "UploadMetadataSignedHeaders":{ 614 "type":"map", 615 "key":{"shape":"UploadMetadataSignedHeadersKey"}, 616 "value":{"shape":"UploadMetadataSignedHeadersValue"} 617 }, 618 "UploadMetadataSignedHeadersKey":{ 619 "type":"string", 620 "max":128, 621 "min":1 622 }, 623 "UploadMetadataSignedHeadersValue":{ 624 "type":"string", 625 "max":256, 626 "min":1 627 }, 628 "UploadMetadataUrl":{ 629 "type":"string", 630 "max":2000, 631 "min":1 632 }, 633 "ValidationException":{ 634 "type":"structure", 635 "required":["Message"], 636 "members":{ 637 "Message":{"shape":"Reason"} 638 }, 639 "error":{"httpStatusCode":400}, 640 "exception":true 641 }, 642 "Websocket":{ 643 "type":"structure", 644 "members":{ 645 "Url":{"shape":"PreSignedConnectionUrl"}, 646 "ConnectionExpiry":{"shape":"ISO8601Datetime"} 647 } 648 } 649 } 650} 651