UserPhoneDirectoryGetPagedSortedListRequest
Bases: OCIRequest
Request a table containing the phone directory for a user. Setting isEnterpriseRequested to true will return enterprise directory members in the response if the user is in an enterprise. Otherwise, just the group directory members for a user are returned in the response. The response is either UserPhoneDirectoryGetPagedSortedListResponse or ErrorResponse. The search can be done using multiple criteria. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criteria are included in the results. If no search criteria is specified, all results are returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. The sort can be performed on user last name, first name, department, or receptionist note. The Receptionist Note column is only populated, if the user sending the request is the owner of the Receptionist Note and a Note exists. The following elements are only used in AS data mode and ignored in XS data mode: searchCriteriaMultiPartName
Attributes:
user_id (str):
is_enterprise_info_requested (bool):
response_paging_control (ResponsePagingControl):
sort_by_user_last_name (Optional[SortByUserLastName]):
sort_by_user_first_name (Optional[SortByUserFirstName]):
sort_by_user_department (Optional[SortByUserDepartment]):
sort_by_receptionist_note (Optional[SortByReceptionistNote]):
search_criteria_mode_or (Optional[bool]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
search_criteria_user_name (Optional[List[SearchCriteriaUserName]]):
search_criteria_dn (Optional[List[SearchCriteriaDn]]):
search_criteria_group_location_code (Optional[List[SearchCriteriaGroupLocationCode]]):
search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
search_criteria_mobile_phone_number (Optional[List[SearchCriteriaMobilePhoneNumber]]):
search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):
search_criteria_yahoo_id (Optional[List[SearchCriteriaYahooId]]):
search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):
search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):
search_criteria_title (Optional[List[SearchCriteriaTitle]]):
search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):
search_criteria_multi_part_name (Optional[List[SearchCriteriaMultiPartUserName]]):
Source code in src/mercury_ocip_fast/commands/commands.py
112280 112281 112282 112283 112284 112285 112286 112287 112288 112289 112290 112291 112292 112293 112294 112295 112296 112297 112298 112299 112300 112301 112302 112303 112304 112305 112306 112307 112308 112309 112310 112311 112312 112313 112314 112315 112316 112317 112318 112319 112320 112321 112322 112323 112324 112325 112326 112327 112328 112329 112330 112331 112332 112333 112334 112335 112336 112337 112338 112339 112340 112341 112342 112343 112344 112345 112346 112347 112348 112349 112350 112351 112352 112353 112354 112355 112356 112357 112358 112359 112360 112361 112362 112363 112364 112365 112366 112367 112368 112369 112370 112371 112372 112373 112374 112375 112376 112377 112378 112379 112380 112381 112382 112383 112384 112385 112386 112387 112388 112389 112390 112391 112392 112393 112394 112395 112396 112397 112398 112399 112400 112401 112402 112403 112404 112405 112406 112407 112408 112409 112410 112411 112412 112413 112414 112415 112416 112417 112418 112419 112420 112421 112422 112423 112424 112425 112426 112427 112428 112429 112430 112431 112432 112433 112434 112435 112436 112437 112438 112439 112440 112441 112442 112443 112444 | |
Responses
Bases: OCIDataResponse
Response to UserPhoneDirectoryGetPagedSortedListRequest. Returns the number of entries that would be returned if the response Was not page size restricted. The "My Room Room Id" and "My Room Bridge Id" are only populated for users assigned the "Collaborate-Audio" service. Contains a table with a row for each user and column headings: "User Id", "CLID First Name", "CLID Last Name", "First Name", "Last Name", "Hiragana First Name", "Hiragana Last Name", "Title", "Phone Number", "Extension", "Mobile", "Pager", "Email Address", "Yahoo Id", "Department", "Group Id", "Location", "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country", "IMP Id", "Location Code", "My Room Room Id", "My Room Bridge Id", "Service Name", "Receptionist Note", "User External Id", and "User Place Type". The Service Name represents the localized service name for service instances. The localized values are taken from the BroadworksLabel.properties file. Service Name is currently supporting: AutoAttendant, AutoAttendantStandard, AutoAttendantVideo, CallCenter, CallCenterStandard, CallCenterPremium, HuntGroup, InstantGroupCall, VoiceMessagingGroup, RoutePoint, BroadWorksAnywhere, GroupPaging, FindmeFollowme, VoiceXML, FlexibleSeatingGuest, CollaborateAudio, MeetMeConferencing. For a Regular User or a Virtual On Network Enterprise Extensions, the Service Name is empty. The Receptionist Note column is only populated, if the user sending the request is the owner of the Receptionist Note and a Note exists. "Service Name", "Receptionist Notes", "User External Id", "User Place Type". Attributes:The following columns are returned in AS data mode only
total_number_of_rows (int):
directory_table (OCITable):
Source code in
src/mercury_ocip_fast/commands/commands.py
Example Usage
from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserPhoneDirectoryGetPagedSortedListRequest
client = Client()
command = UserPhoneDirectoryGetPagedSortedListRequest(
user_id=...,
is_enterprise_info_requested=...,
response_paging_control=...,
sort_by_user_last_name=...,
sort_by_user_first_name=...,
sort_by_user_department=...,
sort_by_receptionist_note=...,
search_criteria_mode_or=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_user_name=...,
search_criteria_dn=...,
search_criteria_group_location_code=...,
search_criteria_extension=...,
search_criteria_mobile_phone_number=...,
search_criteria_email_address=...,
search_criteria_yahoo_id=...,
search_criteria_exact_user_group=...,
search_criteria_department_name=...,
search_criteria_user_id=...,
search_criteria_imp_id=...,
search_criteria_title=...,
search_criteria_receptionist_note=...,
search_criteria_multi_part_name=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("UserPhoneDirectoryGetPagedSortedListRequest",
user_id=...,
is_enterprise_info_requested=...,
response_paging_control=...,
sort_by_user_last_name=...,
sort_by_user_first_name=...,
sort_by_user_department=...,
sort_by_receptionist_note=...,
search_criteria_mode_or=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_user_name=...,
search_criteria_dn=...,
search_criteria_group_location_code=...,
search_criteria_extension=...,
search_criteria_mobile_phone_number=...,
search_criteria_email_address=...,
search_criteria_yahoo_id=...,
search_criteria_exact_user_group=...,
search_criteria_department_name=...,
search_criteria_user_id=...,
search_criteria_imp_id=...,
search_criteria_title=...,
search_criteria_receptionist_note=...,
search_criteria_multi_part_name=...,
)
print(response)