Connect / Client / create_contact

create_contact#

Connect.Client.create_contact(**kwargs)#

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'
        }
    }
)
Parameters:

  • InstanceId (string) – [REQUIRED]

  • ClientToken (string) – This field is autopopulated if not provided.

  • RelatedContactId (string) –

  • Attributes (dict) –

    • (string) –

      • (string) –

  • References (dict) –

    • (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) –

        • Arn (string) –

        • StatusReason (string) –

  • Channel (string) – [REQUIRED]

  • InitiationMethod (string) – [REQUIRED]

  • ExpiryDurationInMinutes (integer) –

  • UserInfo (dict) –

    • UserId (string) –

  • InitiateAs (string) –

  • Name (string) –

  • Description (string) –

  • SegmentAttributes (dict) –

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • ContactId (string) –

    • ContactArn (string) –

Exceptions