Contact ¶

class Contact(TypedDict, closed=True):
    arn: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) for the contact.</p>"""
    id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>The identifier for the contact.</p>"""
    initial_contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>If this contact is related to other contacts, this is the ID of the initial contact.</p>"""
    previous_contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>If this contact is not the first contact, this is the ID of the previous contact.</p>"""
    contact_association_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.</p>"""
    initiation_method: NotRequired[
        "capo_connect.types.contact_initiation_method.ContactInitiationMethod"
    ]
    """<p>Indicates how the contact was initiated.</p>"""
    name: NotRequired["capo_connect.types.name.Name"]
    """<p>The name of the contact.</p>"""
    description: NotRequired["capo_connect.types.description.Description"]
    """<p>The description of the contact.</p>"""
    channel: NotRequired["capo_connect.types.channel.Channel"]
    """<p>How the contact reached your contact center.</p>"""
    queue_info: NotRequired["capo_connect.types.queue_info.QueueInfo"]
    """<p>If this contact was queued, this contains information about the queue. </p>"""
    agent_info: NotRequired["capo_connect.types.agent_info.AgentInfo"]
    """<p>Information about the agent who accepted the contact.</p>"""
    initiation_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code> and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For <code>API</code>, this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor started listening to a contact.</p>"""
    disconnect_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.</p>"""
    last_update_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when contact was last updated.</p>"""
    last_paused_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when the contact was last paused.</p>"""
    last_resumed_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when the contact was last resumed.</p>"""
    ring_start_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when ringing started for a campaign call.</p>"""
    total_pause_count: NotRequired[
        "capo_connect.types.total_pause_count.TotalPauseCount"
    ]
    """<p>Total pause count for a contact.</p>"""
    total_pause_duration_in_seconds: NotRequired[
        "capo_connect.types.total_pause_duration_in_seconds.TotalPauseDurationInSeconds"
    ]
    """<p>Total pause duration for a contact in seconds.</p>"""
    scheduled_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp, in Unix epoch time format, at which to start running the inbound flow. </p>"""
    related_contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid">related</a> to this contact.</p>"""
    wisdom_info: NotRequired["capo_connect.types.wisdom_info.WisdomInfo"]
    """<p>Information about Connect Customer Wisdom.</p>"""
    customer_id: NotRequired["capo_connect.types.customer_id.CustomerId"]
    """<p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Connect Customer Voice ID capability, this attribute is populated with the <code>CustomerSpeakerId</code> of the caller.</p>"""
    customer_endpoint: NotRequired["capo_connect.types.endpoint_info.EndpointInfo"]
    """<p>The customer or external third party participant endpoint.</p>"""
    system_endpoint: NotRequired["capo_connect.types.endpoint_info.EndpointInfo"]
    """<p>The system endpoint. For <code>INBOUND</code>, this is the phone number or email address that the customer dialed. For <code>OUTBOUND</code> and <code>EXTERNAL_OUTBOUND</code>, 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.</p>"""
    queue_time_adjustment_seconds: NotRequired[
        "capo_connect.types.queue_time_adjustment_seconds.QueueTimeAdjustmentSeconds"
    ]
    """<p>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.</p>"""
    queue_priority: NotRequired["capo_connect.types.queue_priority.QueuePriority"]
    """<p>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.</p>"""
    tags: NotRequired["capo_connect.types.contact_tag_map.ContactTagMap"]
    """<p>Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.</p>"""
    connected_to_system_timestamp: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when customer endpoint connected to Connect Customer.</p>"""
    routing_criteria: NotRequired["capo_connect.types.routing_criteria.RoutingCriteria"]
    """<p>Latest routing criteria on the contact.</p>"""
    customer: NotRequired["capo_connect.types.customer.Customer"]
    """<p>Information about the Customer on the contact.</p>"""
    campaign: NotRequired["capo_connect.types.campaign.Campaign"]
    answering_machine_detection_status: NotRequired[
        "capo_connect.types.answering_machine_detection_status.AnsweringMachineDetectionStatus"
    ]
    """<p>Indicates how an <a href="https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html">outbound campaign</a> call is actually disposed if the contact is connected to Connect Customer.</p>"""
    customer_voice_activity: NotRequired[
        "capo_connect.types.customer_voice_activity.CustomerVoiceActivity"
    ]
    """<p>Information about customer’s voice activity.</p>"""
    quality_metrics: NotRequired["capo_connect.types.quality_metrics.QualityMetrics"]
    """<p>Information about the quality of the participant's media connection.</p>"""
    chat_metrics: NotRequired["capo_connect.types.chat_metrics.ChatMetrics"]
    """<p>Information about how agent, bot, and customer interact in a chat contact.</p>"""
    disconnect_details: NotRequired[
        "capo_connect.types.disconnect_details.DisconnectDetails"
    ]
    """<p>Information about the call disconnect experience.</p>"""
    additional_email_recipients: NotRequired[
        "capo_connect.types.additional_email_recipients.AdditionalEmailRecipients"
    ]
    """<p>List of additional email addresses for an email contact.</p>"""
    segment_attributes: NotRequired[
        "capo_connect.types.segment_attributes.SegmentAttributes"
    ]
    """<p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Connect Customer 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, <code>connect:Guide</code> or <code>connect:SMS</code>.</p>"""
    recordings: NotRequired["capo_connect.types.recordings.Recordings"]
    """<p>If recording was enabled, this is information about the recordings.</p>"""
    disconnect_reason: NotRequired["capo_connect.types.string.String"]
    """<p>The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by channel, see DisconnectReason under <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Connect Customer Administrator Guide</i>. </p>"""
    contact_evaluations: NotRequired[
        "capo_connect.types.contact_evaluations.ContactEvaluations"
    ]
    """<p>Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.</p>"""
    task_template_info: NotRequired[
        "capo_connect.types.task_template_info_v2.TaskTemplateInfoV2"
    ]
    """<p>If this contact was created using a task template, this contains information about the task template.</p>"""
    contact_details: NotRequired["capo_connect.types.contact_details.ContactDetails"]
    """<p>A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.</p>"""
    outbound_strategy: NotRequired[
        "capo_connect.types.outbound_strategy.OutboundStrategy"
    ]
    """<p>Information about the outbound strategy.</p>"""
    attributes: NotRequired["capo_connect.types.attributes.Attributes"]
    """<p>The attributes of the contact.</p>"""
    next_contacts: NotRequired["capo_connect.types.next_contacts.NextContacts"]
    """<p> List of next contact entries for the contact. </p>"""
    global_resiliency_metadata: NotRequired[
        "capo_connect.types.global_resiliency_metadata.GlobalResiliencyMetadata"
    ]
    """<p>Information about the global resiliency configuration for the contact, including traffic distribution details.</p>"""