Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateContact

Creates a new contact.

Request Syntax


PUT /contact/create-contact HTTP/1.1
Content-type: application/json

{
   "Attributes": { 
      "string" : "string" 
   },
   "Channel": "string",
   "ClientToken": "string",
   "Description": "string",
   "ExpiryDurationInMinutes": number,
   "InitiateAs": "string",
   "InitiationMethod": "string",
   "InstanceId": "string",
   "Name": "string",
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string",
   "SegmentAttributes": { 
      "string" : { 
         "ValueInteger": number,
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   },
   "UserInfo": { 
      "UserId": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 32767.

Value Length Constraints: Minimum length of 0. Maximum length of 32767.

Required: No

Channel

The channel for the contact

Type: String

Valid Values: VOICE | CHAT | TASK | EMAIL

Required: Yes

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Description

A description of the contact.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

ExpiryDurationInMinutes

Number of minutes the contact will be active for before expiring

Type: Integer

Required: No

InitiateAs

Initial state of the contact when it's created

Type: String

Valid Values: CONNECTED_TO_USER

Required: No

InitiationMethod

Indicates how the contact was initiated.

Type: String

Required: Yes

InstanceId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Name

The name of a the contact.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

References

Type: String to Reference object map

Key Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

RelatedContactId

The identifier of the contact in this instance of Amazon Connect.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

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.

Note

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

Type: String to SegmentAttributeValue object map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

UserInfo

User details for the contact

Type: UserInfo object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactArn": "string",
   "ContactId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ContactArn

The Amazon Resource Name (ARN) of the created contact.

Type: String

ContactId

The identifier of the contact in this instance of Amazon Connect.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

Operation cannot be performed at this time as there is a conflict with another operation or contact state.

HTTP Status Code: 409

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429