ConnectParticipant / Client / get_transcript

get_transcript

ConnectParticipant.Client.get_transcript(**kwargs)

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.

For security recommendations, see Amazon Connect Chat security best practices.

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

Note

ConnectionToken is used for invoking this API instead of ParticipantToken.

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

See also: AWS API Documentation

Request Syntax

response = client.get_transcript(
    ContactId='string',
    MaxResults=123,
    NextToken='string',
    ScanDirection='FORWARD'|'BACKWARD',
    SortOrder='DESCENDING'|'ASCENDING',
    StartPosition={
        'Id': 'string',
        'AbsoluteTime': 'string',
        'MostRecent': 123
    },
    ConnectionToken='string'
)

Parameters:

• 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.

• SortOrder (string) – The sort order for the records. Default: DESCENDING.

• StartPosition (dict) –

  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) –

  [REQUIRED]

  The authentication token associated with the participant’s connection.

Return type:

dict

Returns:

Response Syntax

{
    'InitialContactId': 'string',
    'Transcript': [
        {
            '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': [
                {
                    'ContentType': 'string',
                    'AttachmentId': 'string',
                    'AttachmentName': 'string',
                    'Status': 'APPROVED'|'REJECTED'|'IN_PROGRESS'
                },
            ],
            'MessageMetadata': {
                'MessageId': 'string',
                'Receipts': [
                    {
                        'DeliveredTimestamp': 'string',
                        'ReadTimestamp': 'string',
                        'RecipientParticipantId': 'string'
                    },
                ]
            },
            'RelatedContactId': 'string',
            'ContactId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • InitialContactId (string) –

    The initial contact ID for the contact.

  • Transcript (list) –

    The list of messages in the session.

    • (dict) –

      An item - message or event - that has been sent.

      • 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.

      • 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.

      • Attachments (list) –

        Provides information about the attachments.

        • (dict) –

          The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.

          • 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.

      • MessageMetadata (dict) –

        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 (list) –

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

          • (dict) –

            The receipt for the message delivered to the recipient.

            • 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.

Exceptions

• ConnectParticipant.Client.exceptions.AccessDeniedException

• ConnectParticipant.Client.exceptions.InternalServerException

• ConnectParticipant.Client.exceptions.ThrottlingException

• ConnectParticipant.Client.exceptions.ValidationException