Contact
Contains information about a contact.
Contents
- AdditionalEmailRecipients
-
List of additional email addresses for an email contact.
Type: AdditionalEmailRecipients object
Required: No
- AgentInfo
-
Information about the agent who accepted the contact.
Type: AgentInfo object
Required: No
- AnsweringMachineDetectionStatus
-
Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
Type: String
Valid Values:
ANSWERED | UNDETECTED | ERROR | HUMAN_ANSWERED | SIT_TONE_DETECTED | SIT_TONE_BUSY | SIT_TONE_INVALID_NUMBER | FAX_MACHINE_DETECTED | VOICEMAIL_BEEP | VOICEMAIL_NO_BEEP | AMD_UNRESOLVED | AMD_UNANSWERED | AMD_ERROR | AMD_NOT_APPLICABLE
Required: No
- Arn
-
The Amazon Resource Name (ARN) for the contact.
Type: String
Required: No
- Campaign
-
Information associated with a campaign.
Type: Campaign object
Required: No
- Channel
-
How the contact reached your contact center.
Type: String
Valid Values:
VOICE | CHAT | TASK | EMAIL
Required: No
- ConnectedToSystemTimestamp
-
The timestamp when customer endpoint connected to Amazon Connect.
Type: Timestamp
Required: No
- ContactAssociationId
-
This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Customer
-
Information about the Customer on the contact.
Type: Customer object
Required: No
- CustomerEndpoint
-
The customer or external third party participant endpoint.
Type: EndpointInfo object
Required: No
- CustomerVoiceActivity
-
Information about customer’s voice activity.
Type: CustomerVoiceActivity object
Required: No
- Description
-
The description of the contact.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- DisconnectDetails
-
Information about the call disconnect experience.
Type: DisconnectDetails object
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 | WEBRTC_API | AGENT_REPLY | FLOW
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 1024.
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
- QualityMetrics
-
Information about the quality of the participant's media connection.
Type: QualityMetrics object
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
- RoutingCriteria
-
Latest routing criteria on the contact.
Type: RoutingCriteria object
Required: No
- ScheduledTimestamp
-
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
Type: Timestamp
Required: No
- SegmentAttributes
-
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example,
connect:Guide
orconnect:SMS
.Type: String to SegmentAttributeValue object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- SystemEndpoint
-
The system endpoint. For
INBOUND
, this is the phone number or email address that the customer dialed. ForOUTBOUND
andEXTERNAL_OUTBOUND
, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.Type: EndpointInfo object
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: