Skip to content

aws.connectparticipant.get_transcript

Example SQL Queries

SELECT * FROM
aws.connectparticipant.get_transcript
WHERE
"connection_token" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
connection_token Required Input Column

The authentication token associated with the participant's connection.

VARCHAR
contact_id Input Column

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

VARCHAR
max_results Input Column

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

BIGINT
next_token Input Column

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

VARCHAR
scan_direction Input Column

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

VARCHAR
sort_order Input Column

The sort order for the records. Default: DESCENDING.

VARCHAR
start_position Input Column

A filtering option for where to start.

STRUCT(
"id" VARCHAR,
"absolute_time" VARCHAR,
"most_recent" BIGINT
)
Show child fields
start_position.absolute_time

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.

start_position.id

The ID of the message or event where to start.

start_position.most_recent

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

_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

initial_contact_id

The initial contact ID for the contact.

VARCHAR
transcript

The list of messages in the session.

STRUCT(
"absolute_time" VARCHAR,
"content" VARCHAR,
"content_type" VARCHAR,
"id" VARCHAR,
"type" VARCHAR,
"participant_id" VARCHAR,
"display_name" VARCHAR,
"participant_role" VARCHAR,
"attachments" STRUCT(
"content_type" VARCHAR,
"attachment_id" VARCHAR,
"attachment_name" VARCHAR,
"status" VARCHAR
)[],
"message_metadata" STRUCT(
"message_id" VARCHAR,
"receipts" STRUCT(
"delivered_timestamp" VARCHAR,
"read_timestamp" VARCHAR,
"recipient_participant_id" VARCHAR
)[]
),
"related_contact_id" VARCHAR,
"contact_id" VARCHAR
)[]
Show child fields
transcript[]
Show child fields
transcript[].absolute_time

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.

transcript[].attachments[]
Show child fields
transcript[].attachments[].attachment_id

A unique identifier for the attachment.

transcript[].attachments[].attachment_name

A case-sensitive name of the attachment being uploaded.

transcript[].attachments[].content_type

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

transcript[].attachments[].status

Status of the attachment.

transcript[].contact_id

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.

transcript[].content

The content of the message or event.

transcript[].content_type

The type of content of the item.

transcript[].display_name

The chat display name of the sender.

transcript[].id

The ID of the item.

transcript[].message_metadata

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

Show child fields
transcript[].message_metadata.message_id

The identifier of the message that contains the metadata information.

transcript[].message_metadata.receipts[]
Show child fields
transcript[].message_metadata.receipts[].delivered_timestamp

The time when the message was delivered to the recipient.

transcript[].message_metadata.receipts[].read_timestamp

The time when the message was read by the recipient.

transcript[].message_metadata.receipts[].recipient_participant_id

The identifier of the recipient of the message.

transcript[].participant_id

The ID of the sender in the session.

transcript[].participant_role

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

transcript[].related_contact_id

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.

transcript[].type

Type of the item: message or event.