List Contact References

connect_list_contact_references

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.

For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

Usage

connect_list_contact_references(InstanceId, ContactId, ReferenceTypes,
  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 initial contact.

ReferenceTypes

[required] The type of reference.

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.

This is not expected to be set, because the value returned in the previous response is always null.

Value

A list with the following syntax:

list(
  ReferenceSummaryList = list(
    list(
      Url = list(
        Name = "string",
        Value = "string"
      ),
      Attachment = list(
        Name = "string",
        Value = "string",
        Status = "APPROVED"|"REJECTED"
      ),
      String = list(
        Name = "string",
        Value = "string"
      ),
      Number = list(
        Name = "string",
        Value = "string"
      ),
      Date = list(
        Name = "string",
        Value = "string"
      ),
      Email = list(
        Name = "string",
        Value = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_contact_references(
  InstanceId = "string",
  ContactId = "string",
  ReferenceTypes = list(
    "URL"|"ATTACHMENT"|"NUMBER"|"STRING"|"DATE"|"EMAIL"
  ),
  NextToken = "string"
)