transcripts
Creates, updates, deletes, gets or lists a transcripts resource.
Overview
| Name | transcripts |
| Type | Resource |
| Id | aws.connectparticipant.transcripts |
Fields
The following fields are returned by SELECT queries:
- get_transcript
| Name | Datatype | Description |
|---|---|---|
initial_contact_id | string | The initial contact ID for the contact. |
next_token | string | The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results. |
transcript | array | The list of messages in the session. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_transcript | select | X-Amz-Bearer, region | 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 Connect Customer 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.invited application/vnd.amazonaws.connect.event.participant.joined application/vnd.amazonaws.connect.event.participant.left 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
X-Amz-Bearer | string | The authentication token associated with the participant's connection. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_transcript
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 Connect Customer 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.invited application/vnd.amazonaws.connect.event.participant.joined application/vnd.amazonaws.connect.event.participant.left 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.
SELECT
initial_contact_id,
next_token,
transcript
FROM aws.connectparticipant.transcripts
WHERE `X-Amz-Bearer` = '{{ X-Amz-Bearer }}' -- required
AND region = '{{ region }}' -- required
;