Connect / Client / create_contact

create_contact#

Connect.Client.create_contact(**kwargs)#

Creates a new contact.

See also: AWS API Documentation

Request Syntax

response = client.create_contact(
    InstanceId='string',
    ClientToken='string',
    RelatedContactId='string',
    Attributes={
        'string': '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'
        }
    },
    Channel='VOICE'|'CHAT'|'TASK'|'EMAIL',
    InitiationMethod='INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW',
    ExpiryDurationInMinutes=123,
    UserInfo={
        'UserId': 'string'
    },
    InitiateAs='CONNECTED_TO_USER',
    Name='string',
    Description='string',
    SegmentAttributes={
        'string': {
            'ValueString': 'string',
            'ValueMap': {
                'string': {'... recursive ...'}
            },
            'ValueInteger': 123
        }
    }
)
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.

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    This field is autopopulated if not provided.

  • RelatedContactId (string) – The identifier of the contact in this instance of Amazon Connect.

  • Attributes (dict) –

    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    • (string) –

      • (string) –

  • References (dict) –

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.

    • (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.

  • Channel (string) –

    [REQUIRED]

    The channel for the contact

  • InitiationMethod (string) –

    [REQUIRED]

    Indicates how the contact was initiated.

  • ExpiryDurationInMinutes (integer) – Number of minutes the contact will be active for before expiring

  • UserInfo (dict) –

    User details for the contact

    • UserId (string) –

      The user identifier for the contact.

  • InitiateAs (string) – Initial state of the contact when it’s created

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

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

  • 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 set Segment Contact Expiry as a duration in minutes.

    Note

    To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

    • (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.

Return type:

dict

Returns:

Response Syntax

{
    'ContactId': 'string',
    'ContactArn': 'string'
}

Response Structure

  • (dict) –

    • ContactId (string) –

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

    • ContactArn (string) –

      The Amazon Resource Name (ARN) of the created contact.

Exceptions