Search Contacts

connect_search_contacts

R Documentation

Searches contacts in an Amazon Connect instance

Description

Searches contacts in an Amazon Connect instance.

Usage

connect_search_contacts(InstanceId, TimeRange, SearchCriteria,
  MaxResults, NextToken, Sort)

Arguments

InstanceId

[required] The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

TimeRange

[required] Time range that you want to search results.

SearchCriteria

The search criteria to be used to return contacts.

MaxResults

The maximum number of results to return per page.

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.

Sort

Specifies a field to sort by and a sort order.

Value

A list with the following syntax:

list(
  Contacts = list(
    list(
      Arn = "string",
      Id = "string",
      InitialContactId = "string",
      PreviousContactId = "string",
      InitiationMethod = "INBOUND"|"OUTBOUND"|"TRANSFER"|"QUEUE_TRANSFER"|"CALLBACK"|"API"|"DISCONNECT"|"MONITOR"|"EXTERNAL_OUTBOUND",
      Channel = "VOICE"|"CHAT"|"TASK",
      QueueInfo = list(
        Id = "string",
        EnqueueTimestamp = as.POSIXct(
          "2015-01-01"
        )
      ),
      AgentInfo = list(
        Id = "string",
        ConnectedToAgentTimestamp = as.POSIXct(
          "2015-01-01"
        )
      ),
      InitiationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      DisconnectTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ScheduledTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string",
  TotalCount = 123
)

Request syntax

svc$search_contacts(
  InstanceId = "string",
  TimeRange = list(
    Type = "INITIATION_TIMESTAMP"|"SCHEDULED_TIMESTAMP"|"CONNECTED_TO_AGENT_TIMESTAMP"|"DISCONNECT_TIMESTAMP",
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  SearchCriteria = list(
    AgentIds = list(
      "string"
    ),
    AgentHierarchyGroups = list(
      L1Ids = list(
        "string"
      ),
      L2Ids = list(
        "string"
      ),
      L3Ids = list(
        "string"
      ),
      L4Ids = list(
        "string"
      ),
      L5Ids = list(
        "string"
      )
    ),
    Channels = list(
      "VOICE"|"CHAT"|"TASK"
    ),
    ContactAnalysis = list(
      Transcript = list(
        Criteria = list(
          list(
            ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
            SearchText = list(
              "string"
            ),
            MatchType = "MATCH_ALL"|"MATCH_ANY"
          )
        ),
        MatchType = "MATCH_ALL"|"MATCH_ANY"
      )
    ),
    InitiationMethods = list(
      "INBOUND"|"OUTBOUND"|"TRANSFER"|"QUEUE_TRANSFER"|"CALLBACK"|"API"|"DISCONNECT"|"MONITOR"|"EXTERNAL_OUTBOUND"
    ),
    QueueIds = list(
      "string"
    ),
    SearchableContactAttributes = list(
      Criteria = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      MatchType = "MATCH_ALL"|"MATCH_ANY"
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  Sort = list(
    FieldName = "INITIATION_TIMESTAMP"|"SCHEDULED_TIMESTAMP"|"CONNECTED_TO_AGENT_TIMESTAMP"|"DISCONNECT_TIMESTAMP"|"INITIATION_METHOD"|"CHANNEL",
    Order = "ASCENDING"|"DESCENDING"
  )
)