Get Transcript

connectparticipant_get_transcript

R Documentation

Retrieves a transcript of the session, including details about any attachments

Description

Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat.

If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:

• application/vnd.amazonaws.connect.event.participant.left

• application/vnd.amazonaws.connect.event.participant.joined

• application/vnd.amazonaws.connect.event.chat.ended

• application/vnd.amazonaws.connect.event.transfer.succeeded

• application/vnd.amazonaws.connect.event.transfer.failed

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Usage

connectparticipant_get_transcript(ContactId, MaxResults, NextToken,
  ScanDirection, SortOrder, StartPosition, ConnectionToken)

Arguments

ContactId

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

MaxResults

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

NextToken

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

ScanDirection

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

SortOrder

The sort order for the records. Default: DESCENDING.

StartPosition

A filtering option for where to start.

ConnectionToken

[required] The authentication token associated with the participant's connection.

Value

A list with the following syntax:

list(
  InitialContactId = "string",
  Transcript = list(
    list(
      AbsoluteTime = "string",
      Content = "string",
      ContentType = "string",
      Id = "string",
      Type = "TYPING"|"PARTICIPANT_JOINED"|"PARTICIPANT_LEFT"|"CHAT_ENDED"|"TRANSFER_SUCCEEDED"|"TRANSFER_FAILED"|"MESSAGE"|"EVENT"|"ATTACHMENT"|"CONNECTION_ACK"|"MESSAGE_DELIVERED"|"MESSAGE_READ",
      ParticipantId = "string",
      DisplayName = "string",
      ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
      Attachments = list(
        list(
          ContentType = "string",
          AttachmentId = "string",
          AttachmentName = "string",
          Status = "APPROVED"|"REJECTED"|"IN_PROGRESS"
        )
      ),
      MessageMetadata = list(
        MessageId = "string",
        Receipts = list(
          list(
            DeliveredTimestamp = "string",
            ReadTimestamp = "string",
            RecipientParticipantId = "string"
          )
        )
      ),
      RelatedContactId = "string",
      ContactId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_transcript(
  ContactId = "string",
  MaxResults = 123,
  NextToken = "string",
  ScanDirection = "FORWARD"|"BACKWARD",
  SortOrder = "DESCENDING"|"ASCENDING",
  StartPosition = list(
    Id = "string",
    AbsoluteTime = "string",
    MostRecent = 123
  ),
  ConnectionToken = "string"
)