Only the VOICE, EMAIL, and TASK channels are supported¶

Description¶

Only the VOICE, EMAIL, and TASK channels are supported.

• For VOICE: The supported initiation method is TRANSFER. The contacts created with this initiation method have a subtype connect:ExternalAudio.
• For EMAIL: The supported initiation methods are OUTBOUND, AGENT_REPLY, and FLOW.
• For TASK: The supported initiation method is 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.

Usage¶

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

Arguments¶

• InstanceId

  [required] The identifier of the Connect Customer 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 Connect Customer.

• Attributes

  A custom key-value pair using an attribute map. The attributes are standard Connect Customer 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.

  The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

• InitiationMethod

  [required] Indicates how the contact was initiated.

  CreateContact only supports the following initiation methods. Valid values by channel are:

  • For VOICE: TRANSFER and the subtype connect:ExternalAudio
  • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW
  • For TASK: API

  The other channels listed below are incorrect. We're working to correct this information.

• ExpiryDurationInMinutes

  Number of minutes the contact will be active for before expiring

• UserInfo

  User details for the contact

  UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

• InitiateAs

  Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.

• 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 Connect Customer 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\}\}\}\}.

• 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 Connect Customer Contact Lens with external voice systems in the Connect Customer Administrator Guide.

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"|"EMAIL_MESSAGE_PLAIN_TEXT"|"EMAIL_MESSAGE_PLAIN_TEXT_REDACTED"|"EMAIL_MESSAGE_REDACTED",
      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"|"COMPLETED",
  Name = "string",
  Description = "string",
  SegmentAttributes = list(
    list(
      ValueString = "string",
      ValueMap = list(
        list()
      ),
      ValueInteger = 123,
      ValueList = list(
        list()
      ),
      ValueArn = "string"
    )
  ),
  PreviousContactId = "string"
)