Contact
Contains information about a contact.
Contents
- AgentInfo
-
Information about the agent who accepted the contact.
Type: AgentInfo object
Required: No
- Arn
-
The Amazon Resource Name (ARN) for the contact.
Type: String
Required: No
- Channel
-
How the contact reached your contact center.
Type: String
Valid Values:
VOICE | CHAT | TASK
Required: No
- Description
-
The description of the contact.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- DisconnectTimestamp
-
The timestamp when the customer endpoint disconnected from Amazon Connect.
Type: Timestamp
Required: No
- Id
-
The identifier for the contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- InitialContactId
-
If this contact is related to other contacts, this is the ID of the initial contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- InitiationMethod
-
Indicates how the contact was initiated.
Type: String
Valid Values:
INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API | DISCONNECT | MONITOR | EXTERNAL_OUTBOUND
Required: No
- InitiationTimestamp
-
The date and time this contact was initiated, in UTC time. For
INBOUND
, this is when the contact arrived. ForOUTBOUND
, this is when the agent began dialing. ForCALLBACK
, this is when the callback contact was created. ForTRANSFER
andQUEUE_TRANSFER
, this is when the transfer was initiated. ForAPI
, this is when the request arrived. ForEXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. ForMONITOR
, this is when the supervisor started listening to a contact.Type: Timestamp
Required: No
- LastPausedTimestamp
-
The timestamp when the contact was last paused.
Type: Timestamp
Required: No
- LastResumedTimestamp
-
The timestamp when the contact was last resumed.
Type: Timestamp
Required: No
- LastUpdateTimestamp
-
The timestamp when contact was last updated.
Type: Timestamp
Required: No
- Name
-
The name of the contact.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Required: No
- PreviousContactId
-
If this contact is not the first contact, this is the ID of the previous contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- QueueInfo
-
If this contact was queued, this contains information about the queue.
Type: QueueInfo object
Required: No
- QueuePriority
-
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.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 9223372036854775807.
Required: No
- QueueTimeAdjustmentSeconds
-
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.
Type: Integer
Required: No
- RelatedContactId
-
The contactId that is related to this contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- ScheduledTimestamp
-
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
Type: Timestamp
Required: No
- Tags
-
Tags associated with the contact. This contains both AWS generated and user-defined tags.
Type: String to string map
Map Entries: Maximum number of 6 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Required: No
- TotalPauseCount
-
Total pause count for a contact.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10.
Required: No
- TotalPauseDurationInSeconds
-
Total pause duration for a contact in seconds.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- WisdomInfo
-
Information about Amazon Connect Wisdom.
Type: WisdomInfo object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: