Class: AWS.ConnectParticipant

var params = {
  ParticipantToken: 'STRING_VALUE', /* required */
  ConnectParticipant: true || false,
  Type: [
    WEBSOCKET | CONNECTION_CREDENTIALS,
    /* more items */
  ]
};
connectparticipant.createParticipantConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Type — (Array<String>)

    Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.

  • ParticipantToken — (String)

    This is a header parameter.

    The ParticipantToken as obtained from StartChatContact API response.

  • ConnectParticipant — (Boolean)

    Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Websocket — (map)

      Creates the participant's websocket connection.

      • Url — (String)

        The URL of the websocket.

      • ConnectionExpiry — (String)

        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.

    • ConnectionCredentials — (map)

      Creates the participant's connection credentials. The authentication token associated with the participant's connection.

      • ConnectionToken — (String)

        The connection token.

      • Expiry — (String)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  ViewToken: 'STRING_VALUE' /* required */
};
connectparticipant.describeView(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ViewToken — (String)

    An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.

  • ConnectionToken — (String)

    The connection token.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • View — (map)

      A view resource object. Contains metadata and content necessary to render the view.

      • Id — (String)

        The identifier of the view.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the view.

      • Name — (String)

        The name of the view.

      • Version — (Integer)

        The current version of the view.

      • Content — (map)

        View content containing all content necessary to render a view except for runtime input data.

        • InputSchema — (String)

          The schema representing the input data that the view template must be supplied to render.

        • Template — (String)

          The view template representing the structure of the view.

        • Actions — (Array<String>)

          A list of actions possible from the view

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connectparticipant.disconnectParticipant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ConnectionToken — (String)

    The authentication token associated with the participant's connection.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AttachmentId: 'STRING_VALUE', /* required */
  ConnectionToken: 'STRING_VALUE' /* required */
};
connectparticipant.getAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AttachmentId — (String)

    A unique identifier for the attachment.

  • ConnectionToken — (String)

    The authentication token associated with the participant's connection.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Url — (String)

      This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

    • UrlExpiry — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  ContactId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ScanDirection: FORWARD | BACKWARD,
  SortOrder: DESCENDING | ASCENDING,
  StartPosition: {
    AbsoluteTime: 'STRING_VALUE',
    Id: 'STRING_VALUE',
    MostRecent: 'NUMBER_VALUE'
  }
};
connectparticipant.getTranscript(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ContactId — (String)

    The contactId from the current contact chain for which transcript is needed.

  • MaxResults — (Integer)

    The maximum number of results to return in the page. Default: 10.

  • NextToken — (String)

    The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

  • ScanDirection — (String)

    The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

    Possible values include:
    • "FORWARD"
    • "BACKWARD"
  • SortOrder — (String)

    The sort order for the records. Default: DESCENDING.

    Possible values include:
    • "DESCENDING"
    • "ASCENDING"
  • StartPosition — (map)

    A filtering option for where to start.

    • Id — (String)

      The ID of the message or event where to start.

    • AbsoluteTime — (String)

      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.

    • MostRecent — (Integer)

      The start position of the most recent message where you want to start.

  • ConnectionToken — (String)

    The authentication token associated with the participant's connection.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InitialContactId — (String)

      The initial contact ID for the contact.

    • Transcript — (Array<map>)

      The list of messages in the session.

      • AbsoluteTime — (String)

        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.

      • Content — (String)

        The content of the message or event.

      • ContentType — (String)

        The type of content of the item.

      • Id — (String)

        The ID of the item.

      • Type — (String)

        Type of the item: message or event.

        Possible values include:
        • "TYPING"
        • "PARTICIPANT_JOINED"
        • "PARTICIPANT_LEFT"
        • "CHAT_ENDED"
        • "TRANSFER_SUCCEEDED"
        • "TRANSFER_FAILED"
        • "MESSAGE"
        • "EVENT"
        • "ATTACHMENT"
        • "CONNECTION_ACK"
        • "MESSAGE_DELIVERED"
        • "MESSAGE_READ"
      • ParticipantId — (String)

        The ID of the sender in the session.

      • DisplayName — (String)

        The chat display name of the sender.

      • ParticipantRole — (String)

        The role of the sender. For example, is it a customer, agent, or system.

        Possible values include:
        • "AGENT"
        • "CUSTOMER"
        • "SYSTEM"
        • "CUSTOM_BOT"
        • "SUPERVISOR"
      • Attachments — (Array<map>)

        Provides information about the attachments.

        • ContentType — (String)

          Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

        • AttachmentId — (String)

          A unique identifier for the attachment.

        • AttachmentName — (String)

          A case-sensitive name of the attachment being uploaded.

        • Status — (String)

          Status of the attachment.

          Possible values include:
          • "APPROVED"
          • "REJECTED"
          • "IN_PROGRESS"
      • MessageMetadata — (map)

        The metadata related to the message. Currently this supports only information related to message receipts.

        • MessageId — (String)

          The identifier of the message that contains the metadata information.

        • Receipts — (Array<map>)

          The list of receipt information for a message for different recipients.

          • DeliveredTimestamp — (String)

            The time when the message was delivered to the recipient.

          • ReadTimestamp — (String)

            The time when the message was read by the recipient.

          • RecipientParticipantId — (String)

            The identifier of the recipient of the message.

      • RelatedContactId — (String)

        The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.

      • ContactId — (String)

        The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.

    • NextToken — (String)

      The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  ContentType: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Content: 'STRING_VALUE'
};
connectparticipant.sendEvent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ContentType — (String)

    The content type of the request. Supported types are:

    • application/vnd.amazonaws.connect.event.typing

    • application/vnd.amazonaws.connect.event.connection.acknowledged (will be deprecated on December 31, 2024)

    • application/vnd.amazonaws.connect.event.message.delivered

    • application/vnd.amazonaws.connect.event.message.read

  • Content — (String)

    The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.

    Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ConnectionToken — (String)

    The authentication token associated with the participant's connection.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Id — (String)

      The ID of the response.

    • AbsoluteTime — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE', /* required */
  ContentType: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connectparticipant.sendMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ContentType — (String)

    The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.

  • Content — (String)

    The content of the message.

    • For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.

    • For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.

    • For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ConnectionToken — (String)

    The authentication token associated with the connection.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Id — (String)

      The ID of the message.

    • AbsoluteTime — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AttachmentName: 'STRING_VALUE', /* required */
  AttachmentSizeInBytes: 'NUMBER_VALUE', /* required */
  ClientToken: 'STRING_VALUE', /* required */
  ConnectionToken: 'STRING_VALUE', /* required */
  ContentType: 'STRING_VALUE' /* required */
};
connectparticipant.startAttachmentUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ContentType — (String)

    Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

  • AttachmentSizeInBytes — (Integer)

    The size of the attachment in bytes.

  • AttachmentName — (String)

    A case-sensitive name of the attachment being uploaded.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ConnectionToken — (String)

    The authentication token associated with the participant's connection.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AttachmentId — (String)

      A unique identifier for the attachment.

    • UploadMetadata — (map)

      Fields to be used while uploading the attachment.

      • Url — (String)

        This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

      • UrlExpiry — (String)

        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.

      • HeadersToInclude — (map<String>)

        The headers to be provided while uploading the file to the URL.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.