RingCentral .Net SDK
Properties | List of all members
RingCentral.SearchDirectoryEntriesRequest Class Reference

Properties

string searchString [get, set]
 String value to filter the contacts. The value specified is searched through the following fields: firstName, lastName, extensionNumber, phoneNumber, email, jobTitle, department, customFieldValue More...
 
string[] searchFields [get, set]
 The list of field to be searched for Enum: firstName, lastName, extensionNumber, phoneNumber, email, jobTitle, department, customFieldValue More...
 
bool? showFederated [get, set]
 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 More...
 
bool? showAdminOnlyContacts [get, set]
 Should show AdminOnly Contacts More...
 
string extensionType [get, set]
 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 More...
 
string siteId [get, set]
 Internal identifier of the business site to which extensions belong Example: 872781797006 More...
 
bool? showExternalContacts [get, set]
 Allows to control whether External (Hybrid) contacts should be returned in the response or not Example: true More...
 
string[] accountIds [get, set]
 The list of Internal identifiers of an accounts Example: 854874047006,422456828004,854874151006 More...
 
string department [get, set]
 Department More...
 
string[] siteIds [get, set]
 The list of Internal identifiers of the business sites to which extensions belong More...
 
string[] extensionStatuses [get, set]
 Extension current state. Enum: Enabled, Disabled, NotActivated More...
 
string[] extensionTypes [get, set]
 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 More...
 
OrderBy[] orderBy [get, set]
 Sorting settings More...
 
long? page [get, set]
 Format: int32 More...
 
long? perPage [get, set]
 Format: int32 More...
 

Property Documentation

◆ accountIds

string [] RingCentral.SearchDirectoryEntriesRequest.accountIds
getset

The list of Internal identifiers of an accounts Example: 854874047006,422456828004,854874151006

◆ department

string RingCentral.SearchDirectoryEntriesRequest.department
getset

Department

◆ extensionStatuses

string [] RingCentral.SearchDirectoryEntriesRequest.extensionStatuses
getset

Extension current state. Enum: Enabled, Disabled, NotActivated

◆ extensionType

string RingCentral.SearchDirectoryEntriesRequest.extensionType
getset

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

◆ extensionTypes

string [] RingCentral.SearchDirectoryEntriesRequest.extensionTypes
getset

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

◆ orderBy

OrderBy [] RingCentral.SearchDirectoryEntriesRequest.orderBy
getset

Sorting settings

◆ page

long? RingCentral.SearchDirectoryEntriesRequest.page
getset

Format: int32

◆ perPage

long? RingCentral.SearchDirectoryEntriesRequest.perPage
getset

Format: int32

◆ searchFields

string [] RingCentral.SearchDirectoryEntriesRequest.searchFields
getset

The list of field to be searched for Enum: firstName, lastName, extensionNumber, phoneNumber, email, jobTitle, department, customFieldValue

◆ searchString

string RingCentral.SearchDirectoryEntriesRequest.searchString
getset

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

◆ showAdminOnlyContacts

bool? RingCentral.SearchDirectoryEntriesRequest.showAdminOnlyContacts
getset

Should show AdminOnly Contacts

◆ showExternalContacts

bool? RingCentral.SearchDirectoryEntriesRequest.showExternalContacts
getset

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

◆ showFederated

bool? RingCentral.SearchDirectoryEntriesRequest.showFederated
getset

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

◆ siteId

string RingCentral.SearchDirectoryEntriesRequest.siteId
getset

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

◆ siteIds

string [] RingCentral.SearchDirectoryEntriesRequest.siteIds
getset

The list of Internal identifiers of the business sites to which extensions belong


The documentation for this class was generated from the following file: