Container for the parameters to the CreateContact operation.
Only the VOICE, EMAIL, and TASK channels are supported.
For VOICE: The supported initiation method is
For EMAIL: The supported initiation methods are
For TASK: The supported initiation method is
TRANSFER. The contacts created
with this initiation method have a subtype connect:ExternalAudio.
OUTBOUND, AGENT_REPLY,
and FLOW.
API. Contacts created with this
API have a sub-type of connect:ExternalTask.
Creates a new VOICE, EMAIL, or TASK contact.
After a contact is created, you can move it to the desired state by using the InitiateAs
parameter. While you can use API to create task contacts that are in the COMPLETED
state, you must contact Amazon Web Services Support before using it for bulk import
use cases. Bulk import causes your requests to be throttled or fail if your CreateContact
limits aren't high enough.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Connect.AmazonConnectRequest
Amazon.Connect.Model.CreateContactRequest
Namespace: Amazon.Connect.Model
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z
Syntax
public class CreateContactRequest : AmazonConnectRequest IAmazonWebServiceRequest
The CreateContactRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateContactRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
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. |
|
|
Channel | Amazon.Connect.Channel |
Gets and sets the property Channel. The channel for the contact. The CHAT channel is not supported. The following information is incorrect. We're working to correct it. |
|
|
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. |
|
|
Description | System.String |
Gets and sets the property Description. A description of the contact. |
|
|
ExpiryDurationInMinutes | System.Int32 |
Gets and sets the property ExpiryDurationInMinutes. Number of minutes the contact will be active for before expiring |
|
|
InitiateAs | Amazon.Connect.InitiateAs |
Gets and sets the property InitiateAs.
Initial state of the contact when it's created. Only TASK channel contacts can be
initiated with |
|
|
InitiationMethod | Amazon.Connect.ContactInitiationMethod |
Gets and sets the property InitiationMethod. Indicates how the contact was initiated. CreateContact only supports the following initiation methods. Valid values by channel are:
The other channels listed below are incorrect. We're working to correct this information. |
|
|
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. |
|
|
Name | System.String |
Gets and sets the property Name. The name of a the contact. |
|
|
PreviousContactId | System.String |
Gets and sets the property PreviousContactId. The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide. |
|
|
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). Tasks
can have the following reference types at the time of creation: |
|
|
RelatedContactId | System.String |
Gets and sets the property RelatedContactId. The identifier of the contact in this instance of Amazon Connect. |
|
|
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 (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.
To set contact expiry, a ValueMap must be specified containing the integer number
of minutes the contact will be active for before expiring, with |
|
|
UserInfo | Amazon.Connect.Model.UserInfo |
Gets and sets the property UserInfo. User details for the contact
UserInfo is required when creating an EMAIL contact with |
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