EnterpriseUserCallForwardingSettingsGetListRequest
Bases: OCIRequest
Get a list of users and the service settings for a Call Forwarding service. The response is either EnterpriseUserCallForwardingSettingsGetListResponse or ErrorResponse. By default, virtual users and non-virtual users that match the selected search criteria are included in the response when "includeVirtualUsers" is present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users are returned. The search can be performed using multiple criteria. If search criteria is specified, only the users matching all of the specified search criteria are included in the response. If no search criteria is specified, all results are returned.
Attributes:
service_provider_id (str):
call_forwarding_service (str):
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_dn (Optional[SortByDn]):
sort_by_extension (Optional[SortByExtension]):
sort_by_group_id (Optional[SortByGroupId]):
sort_by_forwarded_to_number (Optional[SortByForwardedToNumber]):
include_virtual_users (Optional[bool]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_dn (Optional[List[SearchCriteriaDn]]):
search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):
search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):
search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):
search_criteria_forwarded_to_number (Optional[List[SearchCriteriaForwardedToNumber]]):
Source code in src/mercury_ocip_fast/commands/commands.py
30128 30129 30130 30131 30132 30133 30134 30135 30136 30137 30138 30139 30140 30141 30142 30143 30144 30145 30146 30147 30148 30149 30150 30151 30152 30153 30154 30155 30156 30157 30158 30159 30160 30161 30162 30163 30164 30165 30166 30167 30168 30169 30170 30171 30172 30173 30174 30175 30176 30177 30178 30179 30180 30181 30182 30183 30184 30185 30186 30187 30188 30189 30190 30191 30192 30193 30194 30195 30196 30197 30198 30199 30200 30201 30202 30203 30204 30205 30206 30207 30208 30209 30210 30211 30212 30213 30214 30215 30216 30217 30218 30219 30220 30221 30222 30223 30224 30225 30226 30227 30228 30229 30230 30231 30232 30233 30234 30235 30236 30237 30238 30239 30240 30241 30242 30243 30244 30245 30246 30247 30248 30249 30250 30251 | |
Responses
Bases: OCIDataResponse
Response to the EnterpriseUserCallForwardingSettingsGetListRequest. Contains a table with column headings: "Group Id", "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name", "Phone Number", "Extension", "Department", "In Trunk Group", "Email Address", "Is Active", "Forwarding Address". "Is Active" is "true" or "false". The "Forwarding Address" is the Call Forwarding service's forwarding address. If the service is Call Forwarding Selective, the default forwarding address is returned. "Phone Number" field is presented in the E164 format.
Attributes:
user_call_forwarding_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 EnterpriseUserCallForwardingSettingsGetListRequest
client = Client()
command = EnterpriseUserCallForwardingSettingsGetListRequest(
service_provider_id=...,
call_forwarding_service=...,
response_paging_control=...,
sort_by_user_last_name=...,
sort_by_user_first_name=...,
sort_by_user_department=...,
sort_by_dn=...,
sort_by_extension=...,
sort_by_group_id=...,
sort_by_forwarded_to_number=...,
include_virtual_users=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_user_id=...,
search_criteria_dn=...,
search_criteria_extension=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_forwarded_to_number=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("EnterpriseUserCallForwardingSettingsGetListRequest",
service_provider_id=...,
call_forwarding_service=...,
response_paging_control=...,
sort_by_user_last_name=...,
sort_by_user_first_name=...,
sort_by_user_department=...,
sort_by_dn=...,
sort_by_extension=...,
sort_by_group_id=...,
sort_by_forwarded_to_number=...,
include_virtual_users=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_user_id=...,
search_criteria_dn=...,
search_criteria_extension=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_forwarded_to_number=...,
)
print(response)