Skip to content

Create Contact

connect_create_contact R Documentation

Creates a new contact

Description

Creates a new contact.

Usage

connect_create_contact(InstanceId, ClientToken, RelatedContactId,
  Attributes, References, Channel, InitiationMethod,
  ExpiryDurationInMinutes, UserInfo, InitiateAs, Name, Description,
  SegmentAttributes)

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.

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.

RelatedContactId

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

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.

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: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.

Channel

[required] The channel for the contact

InitiationMethod

[required] Indicates how the contact was initiated.

ExpiryDurationInMinutes

Number of minutes the contact will be active for before expiring

UserInfo

User details for the contact

InitiateAs

Initial state of the contact when it's created

Name

The name of a the contact.

Description

A description of the contact.

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 SegmentAttributes like { ⁠ "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": 135\}\}\}\}⁠.

Value

A list with the following syntax: 

list(
  ContactId = "string",
  ContactArn = "string"
)

Request syntax

svc$create_contact(
  InstanceId = "string",
  ClientToken = "string",
  RelatedContactId = "string",
  Attributes = list(
    "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"
    )
  ),
  Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
  InitiationMethod = "INBOUND"|"OUTBOUND"|"TRANSFER"|"QUEUE_TRANSFER"|"CALLBACK"|"API"|"DISCONNECT"|"MONITOR"|"EXTERNAL_OUTBOUND"|"WEBRTC_API"|"AGENT_REPLY"|"FLOW",
  ExpiryDurationInMinutes = 123,
  UserInfo = list(
    UserId = "string"
  ),
  InitiateAs = "CONNECTED_TO_USER",
  Name = "string",
  Description = "string",
  SegmentAttributes = list(
    list(
      ValueString = "string",
      ValueMap = list(
        list()
      ),
      ValueInteger = 123
    )
  )
)