UserPhoneDirectoryGetPagedListRequest
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 UserPhoneDirectoryGetPagedListResponse 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. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. The boolean sortByFirstName is optional. If it is not specified, the response is sorted by Last Name. The Receptionist Note column is only populated, if the user sending the request is the owner of the Receptionist Note and a Note exists.
Attributes:
user_id (str):
is_enterprise_info_requested (bool):
response_paging_control (ResponsePagingControl):
search_criteria_mode_or (Optional[bool]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
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_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):
sort_by_first_name (Optional[bool]):
search_criteria_title (Optional[List[SearchCriteriaTitle]]):
search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):
Source code in src/mercury_ocip_fast/commands/commands.py
112144 112145 112146 112147 112148 112149 112150 112151 112152 112153 112154 112155 112156 112157 112158 112159 112160 112161 112162 112163 112164 112165 112166 112167 112168 112169 112170 112171 112172 112173 112174 112175 112176 112177 112178 112179 112180 112181 112182 112183 112184 112185 112186 112187 112188 112189 112190 112191 112192 112193 112194 112195 112196 112197 112198 112199 112200 112201 112202 112203 112204 112205 112206 112207 112208 112209 112210 112211 112212 112213 112214 112215 112216 112217 112218 112219 112220 112221 112222 112223 112224 112225 112226 112227 112228 112229 112230 112231 112232 112233 112234 112235 112236 112237 112238 112239 112240 112241 112242 112243 112244 112245 112246 112247 112248 112249 112250 112251 112252 112253 112254 112255 112256 112257 112258 112259 112260 112261 112262 112263 112264 112265 112266 112267 112268 112269 112270 112271 112272 112273 112274 112275 112276 112277 | |
Responses
Bases: OCIDataResponse
Response to UserPhoneDirectoryGetPagedListRequest. 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", "First Name", "Last Name", "First Name Unicode", "Last Name Unicode", "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", and "Receptionist Note". 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 response entries are sorted by "Last Name Unicode" first and "First Name unicode" secondarily.
The following columns are only returned in AS data mode:
"Location Code", "My Room Room Id", "My Room Bridge Id", "Service Name", "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.
Attributes:
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 UserPhoneDirectoryGetPagedListRequest
client = Client()
command = UserPhoneDirectoryGetPagedListRequest(
user_id=...,
is_enterprise_info_requested=...,
response_paging_control=...,
search_criteria_mode_or=...,
search_criteria_user_last_name=...,
search_criteria_user_first_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_exact_user_department=...,
search_criteria_user_id=...,
search_criteria_imp_id=...,
sort_by_first_name=...,
search_criteria_title=...,
search_criteria_receptionist_note=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("UserPhoneDirectoryGetPagedListRequest",
user_id=...,
is_enterprise_info_requested=...,
response_paging_control=...,
search_criteria_mode_or=...,
search_criteria_user_last_name=...,
search_criteria_user_first_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_exact_user_department=...,
search_criteria_user_id=...,
search_criteria_imp_id=...,
sort_by_first_name=...,
search_criteria_title=...,
search_criteria_receptionist_note=...,
)
print(response)