Search Users

connect_search_users

R Documentation

Searches users in an Connect Customer instance, with optional filtering

Description

Searches users in an Connect Customer instance, with optional filtering.

AfterContactWorkTimeLimit is returned in milliseconds.

Usage

connect_search_users(InstanceId, NextToken, MaxResults, SearchFilter,
  SearchCriteria)

Arguments

InstanceId	[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
MaxResults	The maximum number of results to return per page.
SearchFilter	Filters to be applied to search results.
SearchCriteria	A structure of search criteria to be used to return contacts.

Value

A list with the following syntax:

list(
  Users = list(
    list(
      Arn = "string",
      DirectoryUserId = "string",
      HierarchyGroupId = "string",
      Id = "string",
      IdentityInfo = list(
        FirstName = "string",
        LastName = "string"
      ),
      PhoneConfig = list(
        PhoneType = "SOFT_PHONE"|"DESK_PHONE",
        AutoAccept = TRUE|FALSE,
        AfterContactWorkTimeLimit = 123,
        DeskPhoneNumber = "string",
        PersistentConnection = TRUE|FALSE
      ),
      RoutingProfileId = "string",
      SecurityProfileIds = list(
        "string"
      ),
      Tags = list(
        "string"
      ),
      Username = "string",
      AutoAcceptConfigs = list(
        list(
          Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
          AutoAccept = TRUE|FALSE,
          AgentFirstCallbackAutoAccept = TRUE|FALSE
        )
      ),
      AfterContactWorkConfigs = list(
        list(
          Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
          AfterContactWorkConfig = list(
            AfterContactWorkTimeLimit = 123
          ),
          AgentFirstCallbackAfterContactWorkConfig = list(
            AfterContactWorkTimeLimit = 123
          )
        )
      ),
      PhoneNumberConfigs = list(
        list(
          Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
          PhoneType = "SOFT_PHONE"|"DESK_PHONE",
          PhoneNumber = "string"
        )
      ),
      PersistentConnectionConfigs = list(
        list(
          Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
          PersistentConnection = TRUE|FALSE
        )
      ),
      VoiceEnhancementConfigs = list(
        list(
          Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
          VoiceEnhancementMode = "VOICE_ISOLATION"|"NOISE_SUPPRESSION"|"NONE"
        )
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax

svc$search_users(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchFilter = list(
    TagFilter = list(
      OrConditions = list(
        list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      AndConditions = list(
        list(
          TagKey = "string",
          TagValue = "string"
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    ),
    UserAttributeFilter = list(
      OrConditions = list(
        list(
          TagConditions = list(
            list(
              TagKey = "string",
              TagValue = "string"
            )
          ),
          HierarchyGroupCondition = list(
            Value = "string",
            HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
          )
        )
      ),
      AndCondition = list(
        TagConditions = list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        ),
        HierarchyGroupCondition = list(
          Value = "string",
          HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      ),
      HierarchyGroupCondition = list(
        Value = "string",
        HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
      )
    )
  ),
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      FieldName = "string",
      Value = "string",
      ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    ),
    ListCondition = list(
      TargetListType = "PROFICIENCIES",
      Conditions = list(
        list(
          StringCondition = list(
            FieldName = "string",
            Value = "string",
            ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
          ),
          NumberCondition = list(
            FieldName = "string",
            MinValue = 123,
            MaxValue = 123,
            ComparisonType = "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
          )
        )
      )
    ),
    HierarchyGroupCondition = list(
      Value = "string",
      HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
    )
  )
)