Connect / Client / start_email_contact

start_email_contact#

Connect.Client.start_email_contact(**kwargs)#

See also: AWS API Documentation

Request Syntax

response = client.start_email_contact(
    InstanceId='string',
    FromEmailAddress={
        'EmailAddress': 'string',
        'DisplayName': 'string'
    },
    DestinationEmailAddress='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'
        }
    },
    Name='string',
    EmailMessage={
        'MessageSourceType': 'RAW',
        'RawMessage': {
            'Subject': 'string',
            'Body': 'string',
            'ContentType': 'string',
            'Headers': {
                'string': 'string'
            }
        }
    },
    AdditionalRecipients={
        'ToAddresses': [
            {
                'EmailAddress': 'string',
                'DisplayName': 'string'
            },
        ],
        'CcAddresses': [
            {
                'EmailAddress': 'string',
                'DisplayName': 'string'
            },
        ]
    },
    Attachments=[
        {
            'FileName': 'string',
            'S3Url': 'string'
        },
    ],
    ContactFlowId='string',
    RelatedContactId='string',
    Attributes={
        'string': 'string'
    },
    SegmentAttributes={
        'string': {
            'ValueString': 'string'
        }
    },
    ClientToken='string'
)
Parameters:

  • InstanceId (string) – [REQUIRED]

  • FromEmailAddress (dict) –

    [REQUIRED]

    • EmailAddress (string) – [REQUIRED]

    • DisplayName (string) –

  • DestinationEmailAddress (string) – [REQUIRED]

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

  • Name (string) –

  • EmailMessage (dict) –

    [REQUIRED]

    • MessageSourceType (string) – [REQUIRED]

    • RawMessage (dict) –

      • Subject (string) – [REQUIRED]

      • Body (string) – [REQUIRED]

      • ContentType (string) – [REQUIRED]

      • Headers (dict) –

        • (string) –

          • (string) –

  • AdditionalRecipients (dict) –

    • ToAddresses (list) –

      • (dict) –

        • EmailAddress (string) – [REQUIRED]

        • DisplayName (string) –

    • CcAddresses (list) –

      • (dict) –

        • EmailAddress (string) – [REQUIRED]

        • DisplayName (string) –

  • Attachments (list) –

    • (dict) –

      • FileName (string) – [REQUIRED]

      • S3Url (string) – [REQUIRED]

  • ContactFlowId (string) –

  • RelatedContactId (string) –

  • Attributes (dict) –

    • (string) –

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

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

Return type:

dict

Returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

  • (dict) –

    • ContactId (string) –

Exceptions