Update Contact

connect_update_contact

R Documentation

This API is in preview release for Amazon Connect and is subject to change

Description

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

You can add or update user-defined contact information for both ongoing and completed contacts.

Usage

connect_update_contact(InstanceId, ContactId, Name, Description,
  References, SegmentAttributes, QueueInfo, UserInfo, CustomerEndpoint,
  SystemEndpoint)

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.

ContactId

[required] The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

Name

The name of the contact.

Description

The description of the contact.

References

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

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 show channel subtype, such as connect:Guide.

Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.

QueueInfo

Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

UserInfo

Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

CustomerEndpoint

The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

SystemEndpoint

External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

Value

An empty list.

Request syntax

svc$update_contact(
  InstanceId = "string",
  ContactId = "string",
  Name = "string",
  Description = "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"
    )
  ),
  SegmentAttributes = list(
    list(
      ValueString = "string",
      ValueMap = list(
        list()
      ),
      ValueInteger = 123
    )
  ),
  QueueInfo = list(
    Id = "string"
  ),
  UserInfo = list(
    UserId = "string"
  ),
  CustomerEndpoint = list(
    Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
    Address = "string"
  ),
  SystemEndpoint = list(
    Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
    Address = "string"
  )
)