connectparticipant-2018-09-07.min.json 4.56 KB
{
  "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": {
    "CreateParticipantConnection": {
      "http": {
        "requestUri": "/participant/connection"
      },
      "input": {
        "type": "structure",
        "required": [
          "Type",
          "ParticipantToken"
        ],
        "members": {
          "Type": {
            "type": "list",
            "member": {}
          },
          "ParticipantToken": {
            "location": "header",
            "locationName": "X-Amz-Bearer"
          }
        }
      },
      "output": {
        "type": "structure",
        "members": {
          "Websocket": {
            "type": "structure",
            "members": {
              "Url": {},
              "ConnectionExpiry": {}
            }
          },
          "ConnectionCredentials": {
            "type": "structure",
            "members": {
              "ConnectionToken": {},
              "Expiry": {}
            }
          }
        }
      }
    },
    "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": {}
      }
    },
    "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": {}
              }
            }
          },
          "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": {}
        }
      }
    }
  },
  "shapes": {}
}