Skip to content

List Associated Contacts

connect_list_associated_contacts R Documentation

Provides information about contact tree, a list of associated contacts with a unique identifier

Description

Provides information about contact tree, a list of associated contacts with a unique identifier.

Usage

connect_list_associated_contacts(InstanceId, ContactId, MaxResults,
  NextToken)

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 in this instance of Amazon Connect.

MaxResults

The maximum number of results to return per page.

The maximum number of results to return per page. The default MaxResult size is 25.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Value

A list with the following syntax: 

list(
  ContactSummaryList = list(
    list(
      ContactId = "string",
      ContactArn = "string",
      InitiationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      DisconnectTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      InitialContactId = "string",
      PreviousContactId = "string",
      RelatedContactId = "string",
      InitiationMethod = "INBOUND"|"OUTBOUND"|"TRANSFER"|"QUEUE_TRANSFER"|"CALLBACK"|"API"|"DISCONNECT"|"MONITOR"|"EXTERNAL_OUTBOUND"|"WEBRTC_API"|"AGENT_REPLY"|"FLOW",
      Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_associated_contacts(
  InstanceId = "string",
  ContactId = "string",
  MaxResults = 123,
  NextToken = "string"
)