Class: Aws::ConnectParticipant::Types::GetTranscriptRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb

Overview

Note:

When making an API call, you may pass GetTranscriptRequest data as a hash:

{
  contact_id: "ContactId",
  max_results: 1,
  next_token: "NextToken",
  scan_direction: "FORWARD", # accepts FORWARD, BACKWARD
  sort_order: "DESCENDING", # accepts DESCENDING, ASCENDING
  start_position: {
    id: "ChatItemId",
    absolute_time: "Instant",
    most_recent: 1,
  },
  connection_token: "ParticipantToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connection_tokenString

The authentication token associated with the participant's connection.

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 319

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#contact_idString

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

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 319

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


319
320
321
322
323
324
325
326
327
328
329
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 319

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 319

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#scan_directionString

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

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 319

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_orderString

The sort order for the records. Default: DESCENDING.

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 319

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_positionTypes::StartPosition

A filtering option for where to start.



319
320
321
322
323
324
325
326
327
328
329
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 319

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end