Start Email Contact

connect_start_email_contact

R Documentation

Creates an inbound email contact and initiates a flow to start the email contact for the customer¶

Description¶

Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.

Usage¶

connect_start_email_contact(InstanceId, FromEmailAddress,
  DestinationEmailAddress, Description, References, Name, EmailMessage,
  AdditionalRecipients, Attachments, ContactFlowId, RelatedContactId,
  Attributes, SegmentAttributes, ClientToken)

Arguments¶

InstanceId

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

FromEmailAddress

[required] The email address of the customer.

DestinationEmailAddress

[required] The email address associated with the instance.

Description

A description of the email contact.

References

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during email creation.

Name

The name of a email that is shown to an agent in the Contact Control Panel (CCP).

EmailMessage

[required] The email message body to be sent to the newly created email.

AdditionalRecipients

The addtional recipients address of the email.

Attachments

List of S3 presigned URLs of email attachments and their file name.

ContactFlowId

The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

RelatedContactId

The contactId that is related to this contact. Linking emails together by using RelatedContactID copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

Attributes

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.

SegmentAttributes

A set of system defined key-value pairs stored on individual contact segments 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.

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\}\}\}\}⁠.

ClientToken

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.

Value¶

A list with the following syntax:

list(
  ContactId = "string"
)

Request syntax¶

svc$start_email_contact(
  InstanceId = "string",
  FromEmailAddress = list(
    EmailAddress = "string",
    DisplayName = "string"
  ),
  DestinationEmailAddress = "string",
  Description = "string",
  References = list(
    list(
      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 = list(
    MessageSourceType = "RAW",
    RawMessage = list(
      Subject = "string",
      Body = "string",
      ContentType = "string",
      Headers = list(
        "string"
      )
    )
  ),
  AdditionalRecipients = list(
    ToAddresses = list(
      list(
        EmailAddress = "string",
        DisplayName = "string"
      )
    ),
    CcAddresses = list(
      list(
        EmailAddress = "string",
        DisplayName = "string"
      )
    )
  ),
  Attachments = list(
    list(
      FileName = "string",
      S3Url = "string"
    )
  ),
  ContactFlowId = "string",
  RelatedContactId = "string",
  Attributes = list(
    "string"
  ),
  SegmentAttributes = list(
    list(
      ValueString = "string",
      ValueMap = list(
        list()
      ),
      ValueInteger = 123
    )
  ),
  ClientToken = "string"
)