Class: Aws::Connect::Types::Contact

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::Contact

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

Contains information about a contact.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :description]

Instance Attribute Summary

• #agent_info ⇒ Types::AgentInfo

  Information about the agent who accepted the contact.

• #arn ⇒ String

  The Amazon Resource Name (ARN) for the contact.

• #channel ⇒ String

  How the contact reached your contact center.

• #description ⇒ String

  The description of the contact.

• #disconnect_timestamp ⇒ Time

  The timestamp when the customer endpoint disconnected from Amazon Connect.

• #id ⇒ String

  The identifier for the contact.

• #initial_contact_id ⇒ String

  If this contact is related to other contacts, this is the ID of the initial contact.

• #initiation_method ⇒ String

  Indicates how the contact was initiated.

• #initiation_timestamp ⇒ Time

  The date and time this contact was initiated, in UTC time.

• #last_paused_timestamp ⇒ Time

  The timestamp when the contact was last paused.

• #last_resumed_timestamp ⇒ Time

  The timestamp when the contact was last resumed.

• #last_update_timestamp ⇒ Time

  The timestamp when contact was last updated.

• #name ⇒ String

  The name of the contact.

• #previous_contact_id ⇒ String

  If this contact is not the first contact, this is the ID of the previous contact.

• #queue_info ⇒ Types::QueueInfo

  If this contact was queued, this contains information about the queue.

• #queue_priority ⇒ Integer

  An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially).

• #queue_time_adjustment_seconds ⇒ Integer

  An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially).

• #related_contact_id ⇒ String

  The contactId that is [related] to this contact.

• #scheduled_timestamp ⇒ Time

  The timestamp, in Unix epoch time format, at which to start running the inbound flow.

• #tags ⇒ Hash<String,String>

  Tags associated with the contact.

• #total_pause_count ⇒ Integer

  Total pause count for a contact.

• #total_pause_duration_in_seconds ⇒ Integer

  Total pause duration for a contact in seconds.

• #wisdom_info ⇒ Types::WisdomInfo

  Information about Amazon Connect Wisdom.

Instance Attribute Details

#agent_info ⇒ Types::AgentInfo

Information about the agent who accepted the contact.

Returns:

• (Types::AgentInfo)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) for the contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#channel ⇒ String

How the contact reached your contact center.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#description ⇒ String

The description of the contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#disconnect_timestamp ⇒ Time

The timestamp when the customer endpoint disconnected from Amazon Connect.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#id ⇒ String

The identifier for the contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#initial_contact_id ⇒ String

If this contact is related to other contacts, this is the ID of the initial contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#initiation_method ⇒ String

Indicates how the contact was initiated.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#initiation_timestamp ⇒ Time

The date and time this contact was initiated, in UTC time. For ‘INBOUND`, this is when the contact arrived. For `OUTBOUND`, this is when the agent began dialing. For `CALLBACK`, this is when the callback contact was created. For `TRANSFER` and `QUEUE_TRANSFER`, this is when the transfer was initiated. For `API`, this is when the request arrived. For `EXTERNAL_OUTBOUND`, this is when the agent started dialing the external participant. For `MONITOR`, this is when the supervisor started listening to a contact.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#last_paused_timestamp ⇒ Time

The timestamp when the contact was last paused.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#last_resumed_timestamp ⇒ Time

The timestamp when the contact was last resumed.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#last_update_timestamp ⇒ Time

The timestamp when contact was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#previous_contact_id ⇒ String

If this contact is not the first contact, this is the ID of the previous contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#queue_info ⇒ Types::QueueInfo

If this contact was queued, this contains information about the queue.

Returns:

• (Types::QueueInfo)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#queue_priority ⇒ Integer

An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

Returns:

• (Integer)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#queue_time_adjustment_seconds ⇒ Integer

An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

Returns:

• (Integer)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#related_contact_id ⇒ String

The contactId that is [related] to this contact.

[1]: docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#scheduled_timestamp ⇒ Time

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#total_pause_count ⇒ Integer

Total pause count for a contact.

Returns:

• (Integer)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#total_pause_duration_in_seconds ⇒ Integer

Total pause duration for a contact in seconds.

Returns:

• (Integer)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#wisdom_info ⇒ Types::WisdomInfo

Information about Amazon Connect Wisdom.

Returns:

• (Types::WisdomInfo)

# File 'lib/aws-sdk-connect/types.rb', line 1720

class Contact < Struct.new(
  :arn,
  :id,
  :initial_contact_id,
  :previous_contact_id,
  :initiation_method,
  :name,
  :description,
  :channel,
  :queue_info,
  :agent_info,
  :initiation_timestamp,
  :disconnect_timestamp,
  :last_update_timestamp,
  :last_paused_timestamp,
  :last_resumed_timestamp,
  :total_pause_count,
  :total_pause_duration_in_seconds,
  :scheduled_timestamp,
  :related_contact_id,
  :wisdom_info,
  :queue_time_adjustment_seconds,
  :queue_priority,
  :tags)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end