Connect / Client / list_associated_contacts

list_associated_contacts#

Connect.Client.list_associated_contacts(**kwargs)#

Provides information about contact tree, a list of associated contacts with a unique identifier.

See also: AWS API Documentation

Request Syntax

response = client.list_associated_contacts(
    InstanceId='string',
    ContactId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact in this instance of Amazon Connect.

  • MaxResults (integer) –

    The maximum number of results to return per page.

    The maximum number of results to return per page. The default MaxResult size is 25.

    Valid Range: Minimum value of 1. Maximum value of 100.

  • NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'ContactSummaryList': [
        {
            'ContactId': 'string',
            'ContactArn': 'string',
            'InitiationTimestamp': datetime(2015, 1, 1),
            'DisconnectTimestamp': datetime(2015, 1, 1),
            'InitialContactId': 'string',
            'PreviousContactId': 'string',
            'RelatedContactId': 'string',
            'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW',
            'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ContactSummaryList (list) –

      List of the contact summary for all the contacts in contact tree associated with unique identifier.

      • (dict) –

        Contact summary of a contact in contact tree associated with unique identifier.

        • ContactId (string) –

          The identifier of the contact in this instance of Amazon Connect.

        • ContactArn (string) –

          The Amazon Resource Name (ARN) of the contact

        • InitiationTimestamp (datetime) –

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

        • DisconnectTimestamp (datetime) –

          The timestamp when the customer endpoint disconnected from Amazon Connect.

        • InitialContactId (string) –

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

        • PreviousContactId (string) –

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

        • RelatedContactId (string) –

          The contactId that is related to this contact.

        • InitiationMethod (string) –

          Indicates how the contact was initiated.

        • Channel (string) –

          How the contact reached your contact center.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException