[ aws . connectparticipant ]

get-transcript

Description

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-transcript
[--contact-id <value>]
[--max-results <value>]
[--next-token <value>]
[--scan-direction <value>]
[--sort-order <value>]
[--start-position <value>]
--connection-token <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--contact-id (string)

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

--max-results (integer)

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

--next-token (string)

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

--scan-direction (string)

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

Possible values:

• FORWARD

• BACKWARD

--sort-order (string)

The sort order for the records. Default: DESCENDING.

Possible values:

• DESCENDING

• ASCENDING

--start-position (structure)

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.

Shorthand Syntax:

Id=string,AbsoluteTime=string,MostRecent=integer

JSON Syntax:

{
  "Id": "string",
  "AbsoluteTime": "string",
  "MostRecent": integer
}

--connection-token (string)

The authentication token associated with the participant’s connection.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

InitialContactId -> (string)

The initial contact ID for the contact.

Transcript -> (list)

The list of messages in the session.

(structure)

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.

NextToken -> (string)

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