class Aws::Connect::Types::CreateContactRequest


@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactRequest AWS API Documentation
@return [String]<br>: docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html<br><br><br><br>Guide*.
external voice systems] in the *Amazon Connect Administrator
more information, see [Integrate Amazon Connect Contact Lens with
This value can be provided only for external audio contacts. For
The ID of the previous contact when creating a transfer contact.
@!attribute [rw] previous_contact_id
@return [Hash<String,Types::SegmentAttributeValue>]
</note>
“ValueInteger”: 135}}}}‘.
“connect:ContactExpiry”: {“ValueMap” : { “ExpiryDuration”: {
expiring, with `SegmentAttributes` like { `
integer number of minutes the contact will be active for before
<note markdown=“1”> To set contact expiry, a ValueMap must be specified containing the
in minutes.
This field can be used to set Segment Contact Expiry as a duration
Attribute keys can include only alphanumeric, -, and _.
flows.
are standard Amazon Connect attributes. They can be accessed in
segments (unique contact ID) using an attribute map. The attributes
A set of system defined key-value pairs stored on individual contact
@!attribute [rw] segment_attributes
@return [String]
A description of the contact.
@!attribute [rw] description
@return [String]
The name of a the contact.
@!attribute [rw] name
@return [String]
contacts can be initiated with `COMPLETED` state.
Initial state of the contact when it’s created. Only TASK channel
@!attribute [rw] initiate_as
@return [Types::UserInfo]
and ‘AGENT_REPLY` contact initiation methods.
UserInfo is required when creating an EMAIL contact with `OUTBOUND`
User details for the contact
@!attribute [rw] user_info
@return [Integer]
Number of minutes the contact will be active for before expiring
@!attribute [rw] expiry_duration_in_minutes
@return [String]
correct this information.
The other channels listed below are incorrect. We’re working to
* For TASK: ‘API`
* For EMAIL: `OUTBOUND` | `AGENT_REPLY` | `FLOW`
* For VOICE: `TRANSFER` and the subtype `connect:ExternalAudio`
values by channel are:
CreateContact only supports the following initiation methods. Valid
Indicates how the contact was initiated.
@!attribute [rw] initiation_method
@return [String]
incorrect. We’re working to correct it.
The CHAT channel is not supported. The following information is
The channel for the contact.
@!attribute [rw] channel
@return [Hash<String,Types::Reference>]
| ‘ATTACHMENT`.
time of creation: `URL` | `NUMBER` | `STRING` | `DATE` | `EMAIL`
Panel (CCP). Tasks can have the following reference types at the
A formatted URL that is shown to an agent in the Contact Control
@!attribute [rw] references
@return [Hash<String,String>]
underscore characters.
contact. Attribute keys can include only alphanumeric, dash, and
There can be up to 32,768 UTF-8 bytes across all key-value pairs per
just like any other contact attributes.
standard Amazon Connect attributes, and can be accessed in flows
A custom key-value pair using an attribute map. The attributes are
@!attribute [rw] attributes
@return [String]
The identifier of the contact in this instance of Amazon Connect.
@!attribute [rw] related_contact_id
@return [String]<br>: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
not need to pass this option.
**A suitable default value is auto-generated.** You should normally
see [Making retries safe with idempotent APIs].
SDK populates this field. For more information about idempotency,
idempotency of the request. If not provided, the Amazon Web Services
A unique, case-sensitive identifier that you provide to ensure the
@!attribute [rw] client_token
@return [String]<br>: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html<br><br><br><br>instance ID] in the Amazon Resource Name (ARN) of the instance.
The identifier of the Amazon Connect instance. You can [find the
@!attribute [rw] instance_id