Package com.ringcentral.definitions

Class SearchDirectoryEntriesRequest

java.lang.Object
com.ringcentral.definitions.SearchDirectoryEntriesRequest
public class SearchDirectoryEntriesRequest extends Object

  • Field Details

    • searchString

      public String searchString
      String value to filter the contacts. The value specified is searched through the following fields: `firstName`, `lastName`, `extensionNumber`, `phoneNumber`, `email`, `jobTitle`, `department`, `customFieldValue`

    • searchFields

      public String[] searchFields
      The list of field to be searched for Enum: firstName, lastName, extensionNumber, phoneNumber, email, jobTitle, department, customFieldValue

    • showFederated

      public Boolean showFederated
      If `true` then contacts of all accounts in federation are returned, if it is in federation, account section will be returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case Default: true

    • showAdminOnlyContacts

      public Boolean showAdminOnlyContacts
      Should show AdminOnly Contacts

    • extensionType

      public String extensionType
      Type of directory contact to filter Example: User Enum: User, Department, Announcement, Voicemail, SharedLinesGroup, PagingOnly, ParkLocation, IvrMenu, Limited, ApplicationExtension, Site, Bot, Room, DelegatedLinesGroup, GroupCallPickup, External

    • siteId

      public String siteId
      Internal identifier of the business site to which extensions belong Example: 872781797006

    • showExternalContacts

      public Boolean showExternalContacts
      Allows to control whether External (Hybrid) contacts should be returned in the response or not Example: true

    • accountIds

      public String[] accountIds
      The list of Internal identifiers of an accounts Example: 854874047006,422456828004,854874151006

    • department

      public String department
      Department

    • siteIds

      public String[] siteIds
      The list of Internal identifiers of the business sites to which extensions belong

    • extensionStatuses

      public String[] extensionStatuses
      Extension current state. Enum: Enabled, Disabled, NotActivated

    • extensionTypes

      public String[] extensionTypes
      Types of extension to filter the contacts Enum: User, Department, Announcement, Voicemail, DigitalUser, VirtualUser, FaxUser, PagingOnly, SharedLinesGroup, IvrMenu, ApplicationExtension, ParkLocation, Limited, Bot, Site, Room, ProxyAdmin, DelegatedLinesGroup, FlexibleUser, GroupCallPickup, RoomConnector, TieLine, External

    • extensionIds

      public String[] extensionIds
      The list of internal identifiers of the extension

    • integrationRoutingTypes

      public String[] integrationRoutingTypes
      Enum: Carrier, Account

    • phoneNumberSmsAvailabilityStatuses

      public String[] phoneNumberSmsAvailabilityStatuses
      The list of SMS availability statuses to filter phone numbers Enum: Active, Inactive, Disabled, Banned, Suspended, Deprovisioning, InboundOnly, Unknown

    • phoneNumberSmsCampaignIds

      public String[] phoneNumberSmsCampaignIds
      The list of SMS campaign IDs to filter phone numbers

    • orderBy

      public OrderBy[] orderBy
      Sorting settings

    • page

      public Long page
      Format: int32

    • perPage

      public Long perPage
      Format: int32

  • Constructor Details

    • SearchDirectoryEntriesRequest

      public SearchDirectoryEntriesRequest()

  • Method Details