Connect / Client / update_contact

update_contact

Connect.Client.update_contact(**kwargs)

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

Warning

You can add or update user-defined contact information for both ongoing and completed contacts.

See also: AWS API Documentation

Request Syntax

response = client.update_contact(
    InstanceId='string',
    ContactId='string',
    Name='string',
    Description='string',
    References={
        'string': {
            'Value': 'string',
            'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE',
            'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
            'Arn': 'string',
            'StatusReason': 'string'
        }
    },
    SegmentAttributes={
        'string': {
            'ValueString': 'string',
            'ValueMap': {
                'string': {'... recursive ...'}
            },
            'ValueInteger': 123
        }
    },
    QueueInfo={
        'Id': 'string'
    },
    UserInfo={
        'UserId': 'string'
    },
    CustomerEndpoint={
        'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
        'Address': 'string'
    },
    SystemEndpoint={
        'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
        'Address': '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. This is the identifier of the contact associated with the first interaction with your contact center.

• Name (string) – The name of the contact.

• Description (string) – The description of the contact.

• References (dict) –

  Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

  • (string) –

    • (dict) –

      Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

      • Value (string) –

        A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

      • Type (string) – [REQUIRED]

        The type of the reference. DATE must be of type Epoch timestamp.

      • Status (string) –

        Status of the attachment reference type.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the reference

      • StatusReason (string) –

        Relevant details why the reference was not successfully created.

• SegmentAttributes (dict) –

  A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

  Attribute keys can include only alphanumeric, -, and _.

  This field can be used to show channel subtype, such as connect:Guide.

  Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.

  • (string) –

    • (dict) –

      A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

      • ValueString (string) –

        The value of a segment attribute.

      • ValueMap (dict) –

        The value of a segment attribute.

        • (string) –

          • (dict) –

            A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

      • ValueInteger (integer) –

        The value of a segment attribute.

• QueueInfo (dict) –

  Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

  • Id (string) –

    The identifier of the queue.

• UserInfo (dict) –

  Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

  • UserId (string) –

    The user identifier for the contact.

• CustomerEndpoint (dict) –

  The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer’s phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

  • Type (string) –

    Type of the endpoint.

  • Address (string) –

    Address of the endpoint.

• SystemEndpoint (dict) –

  External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

  • Type (string) –

    Type of the endpoint.

  • Address (string) –

    Address of the endpoint.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.AccessDeniedException

• Connect.Client.exceptions.ConflictException