Search Contacts

connect_search_contacts

R Documentation

Searches contacts in an Connect Customer instance

Description

Searches contacts in an Connect Customer instance.

Usage

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

Arguments

InstanceId	[required] The identifier of Connect Customer 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"|"WEBRTC_API"|"AGENT_REPLY"|"FLOW",
      Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
      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"
      ),
      SegmentAttributes = list(
        list(
          ValueString = "string",
          ValueMap = list(
            list(
              ValueString = "string",
              ValueMap = list(),
              ValueInteger = 123,
              ValueList = list(
                list()
              ),
              ValueArn = "string"
            )
          )
        )
      ),
      Name = "string",
      RoutingCriteria = list(
        Steps = list(
          list(
            Expiry = list(
              DurationInSeconds = 123,
              ExpiryTimestamp = as.POSIXct(
                "2015-01-01"
              )
            ),
            Expression = list(
              AttributeCondition = list(
                Name = "string",
                Value = "string",
                ProficiencyLevel = 123.0,
                Range = list(
                  MinProficiencyLevel = 123.0,
                  MaxProficiencyLevel = 123.0
                ),
                MatchCriteria = list(
                  AgentsCriteria = list(
                    AgentIds = list(
                      "string"
                    )
                  )
                ),
                ComparisonOperator = "string"
              ),
              AndExpression = list(
                list()
              ),
              OrExpression = list(
                list()
              ),
              NotAttributeCondition = list(
                Name = "string",
                Value = "string",
                ProficiencyLevel = 123.0,
                Range = list(
                  MinProficiencyLevel = 123.0,
                  MaxProficiencyLevel = 123.0
                ),
                MatchCriteria = list(
                  AgentsCriteria = list(
                    AgentIds = list(
                      "string"
                    )
                  )
                ),
                ComparisonOperator = "string"
              )
            ),
            Status = "ACTIVE"|"INACTIVE"|"JOINED"|"EXPIRED"
          )
        ),
        ActivationTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        Index = 123
      ),
      Tags = list(
        "string"
      ),
      GlobalResiliencyMetadata = list(
        ActiveRegion = "string",
        OriginRegion = "string",
        TrafficDistributionGroupId = "string"
      )
    )
  ),
  NextToken = "string",
  TotalCount = 123
)

Request syntax

svc$search_contacts(
  InstanceId = "string",
  TimeRange = list(
    Type = "INITIATION_TIMESTAMP"|"SCHEDULED_TIMESTAMP"|"CONNECTED_TO_AGENT_TIMESTAMP"|"DISCONNECT_TIMESTAMP"|"ENQUEUE_TIMESTAMP",
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  SearchCriteria = list(
    Name = list(
      SearchText = list(
        "string"
      ),
      MatchType = "MATCH_ALL"|"MATCH_ANY"|"MATCH_EXACT"|"MATCH_NONE"
    ),
    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"|"EMAIL"
    ),
    ContactAnalysis = list(
      Transcript = list(
        Criteria = list(
          list(
            ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
            SearchText = list(
              "string"
            ),
            MatchType = "MATCH_ALL"|"MATCH_ANY"|"MATCH_EXACT"|"MATCH_NONE"
          )
        ),
        MatchType = "MATCH_ALL"|"MATCH_ANY"|"MATCH_EXACT"|"MATCH_NONE"
      )
    ),
    InitiationMethods = list(
      "INBOUND"|"OUTBOUND"|"TRANSFER"|"QUEUE_TRANSFER"|"CALLBACK"|"API"|"DISCONNECT"|"MONITOR"|"EXTERNAL_OUTBOUND"|"WEBRTC_API"|"AGENT_REPLY"|"FLOW"
    ),
    QueueIds = list(
      "string"
    ),
    RoutingCriteria = list(
      Steps = list(
        list(
          AgentCriteria = list(
            AgentIds = list(
              "string"
            ),
            MatchType = "MATCH_ALL"|"MATCH_ANY"|"MATCH_EXACT"|"MATCH_NONE"
          )
        )
      )
    ),
    AdditionalTimeRange = list(
      Criteria = list(
        list(
          TimeRange = list(
            Type = "INITIATION_TIMESTAMP"|"SCHEDULED_TIMESTAMP"|"CONNECTED_TO_AGENT_TIMESTAMP"|"DISCONNECT_TIMESTAMP"|"ENQUEUE_TIMESTAMP",
            StartTime = as.POSIXct(
              "2015-01-01"
            ),
            EndTime = as.POSIXct(
              "2015-01-01"
            )
          ),
          TimestampCondition = list(
            Type = "INITIATION_TIMESTAMP"|"SCHEDULED_TIMESTAMP"|"CONNECTED_TO_AGENT_TIMESTAMP"|"DISCONNECT_TIMESTAMP"|"ENQUEUE_TIMESTAMP",
            ConditionType = "NOT_EXISTS"
          )
        )
      ),
      MatchType = "MATCH_ALL"|"MATCH_ANY"|"MATCH_EXACT"|"MATCH_NONE"
    ),
    SearchableContactAttributes = list(
      Criteria = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      MatchType = "MATCH_ALL"|"MATCH_ANY"|"MATCH_EXACT"|"MATCH_NONE"
    ),
    SearchableSegmentAttributes = list(
      Criteria = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      MatchType = "MATCH_ALL"|"MATCH_ANY"|"MATCH_EXACT"|"MATCH_NONE"
    ),
    ActiveRegions = list(
      "string"
    ),
    ContactTags = list(
      OrConditions = list(
        list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      AndConditions = list(
        list(
          TagKey = "string",
          TagValue = "string"
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  Sort = list(
    FieldName = "INITIATION_TIMESTAMP"|"SCHEDULED_TIMESTAMP"|"CONNECTED_TO_AGENT_TIMESTAMP"|"DISCONNECT_TIMESTAMP"|"INITIATION_METHOD"|"CHANNEL"|"EXPIRY_TIMESTAMP",
    Order = "ASCENDING"|"DESCENDING"
  )
)