AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartEmailContact operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Connect.AmazonConnectRequest
      Amazon.Connect.Model.StartEmailContactRequest

Namespace: Amazon.Connect.Model
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z

Syntax

C#
public class StartEmailContactRequest : AmazonConnectRequest
         IAmazonWebServiceRequest

The StartEmailContactRequest type exposes the following members

Constructors

NameDescription
Public Method StartEmailContactRequest()

Properties

NameTypeDescription
Public Property AdditionalRecipients Amazon.Connect.Model.InboundAdditionalRecipients

Gets and sets the property AdditionalRecipients.

The addtional recipients address of the email.

Public Property Attachments System.Collections.Generic.List<Amazon.Connect.Model.EmailAttachment>

Gets and sets the property Attachments.

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

Public Property Attributes System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property 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.

Public Property ClientToken System.String

Gets and sets the property 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.

Public Property ContactFlowId System.String

Gets and sets the property 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

Public Property Description System.String

Gets and sets the property Description.

A description of the email contact.

Public Property DestinationEmailAddress System.String

Gets and sets the property DestinationEmailAddress.

The email address associated with the instance.

Public Property EmailMessage Amazon.Connect.Model.InboundEmailContent

Gets and sets the property EmailMessage.

The email message body to be sent to the newly created email.

Public Property FromEmailAddress Amazon.Connect.Model.EmailAddressInfo

Gets and sets the property FromEmailAddress.

The email address of the customer.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

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

Public Property Name System.String

Gets and sets the property Name.

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

Public Property References System.Collections.Generic.Dictionary<System.String, Amazon.Connect.Model.Reference>

Gets and sets the property 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.

Public Property RelatedContactId System.String

Gets and sets the property 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.

Public Property SegmentAttributes System.Collections.Generic.Dictionary<System.String, Amazon.Connect.Model.SegmentAttributeValue>

Gets and sets the property 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}}}}.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5