Skip to content

UserPhoneDirectoryGetListRequest

Bases: OCIRequest

Request a table containing the phone directory for a user's group. If the user's group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group (if includeCommonPhoneList is set to true). If the user's group is part of a service provider, the directory includes all users in the group and all entries in the common phone list (if includeCommonPhoneList is set to true) of the specified group. The response is either UserPhoneDirectoryGetListResponse or ErrorResponse. 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.

Attributes:

user_id (str):

include_common_phone_list (bool):

response_size_limit (Optional[int]):

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_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_mobile_phone_number (Optional[List[SearchCriteriaMobilePhoneNumber]]):

search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

search_criteria_exact_custom_contact_directory (Optional[SearchCriteriaExactCustomContactDirectory]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPhoneDirectoryGetListRequest(OCIRequest):
    """Request a table containing the phone directory for a user's group.
        If the user's group is part of an enterprise, the directory includes all users in the enterprise
        and all entries in the enterprise common phone list and the common phone list of the specified
        group  (if includeCommonPhoneList is set to true).
        If the user's group is part of a service provider, the directory includes all users in the group
        and all entries in the common phone list (if includeCommonPhoneList is set to true) of the
        specified group.
        The response is either UserPhoneDirectoryGetListResponse or ErrorResponse.
        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.

    Attributes:

        user_id (str):

        include_common_phone_list (bool):

        response_size_limit (Optional[int]):

        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_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_mobile_phone_number (Optional[List[SearchCriteriaMobilePhoneNumber]]):

        search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

        search_criteria_exact_custom_contact_directory (Optional[SearchCriteriaExactCustomContactDirectory]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

    """

    user_id: str = field(metadata={"alias": "userId"})

    include_common_phone_list: bool = field(
        metadata={"alias": "includeCommonPhoneList"}
    )

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_mode_or: Optional[bool] = field(
        default=None, metadata={"alias": "searchCriteriaModeOr"}
    )

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

    search_criteria_mobile_phone_number: Optional[
        List[SearchCriteriaMobilePhoneNumber]
    ] = field(default=None, metadata={"alias": "searchCriteriaMobilePhoneNumber"})

    search_criteria_email_address: Optional[List[SearchCriteriaEmailAddress]] = field(
        default=None, metadata={"alias": "searchCriteriaEmailAddress"}
    )

    search_criteria_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

    search_criteria_exact_user_group: Optional[SearchCriteriaExactUserGroup] = field(
        default=None, metadata={"alias": "searchCriteriaExactUserGroup"}
    )

    search_criteria_exact_custom_contact_directory: Optional[
        SearchCriteriaExactCustomContactDirectory
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactCustomContactDirectory"}
    )

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_imp_id: Optional[List[SearchCriteriaImpId]] = field(
        default=None, metadata={"alias": "searchCriteriaImpId"}
    )

Responses

Bases: OCIDataResponse

Response to UserPhoneDirectoryGetListRequest. 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 phone number and column headings : "Name", "Number", "Extension", "Mobile", "Email Address", "Department", "First Name", "Last Name", "User Id", "Title", "IMP Id", "My Room Room Id", "My Room Bridge Id", "Service Name". 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 following columns are only returned in AS data mode:
  "My Room Room Id", "My Room Bridge Id", "Service Name"

Attributes:

directory_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPhoneDirectoryGetListResponse(OCIDataResponse):
    """Response to UserPhoneDirectoryGetListRequest.
        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 phone number and column headings :
        \"Name\", \"Number\", \"Extension\", \"Mobile\", \"Email Address\", \"Department\", \"First Name\", \"Last Name\",
        \"User Id\", \"Title\", \"IMP Id\", \"My Room Room Id\", \"My Room Bridge Id\", \"Service Name\".
        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 following columns are only returned in AS data mode:
          \"My Room Room Id\", \"My Room Bridge Id\", \"Service Name\"

    Attributes:

        directory_table (OCITable):

    """

    directory_table: OCITable = field(metadata={"alias": "directoryTable"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserPhoneDirectoryGetListRequest

client = Client()

command = UserPhoneDirectoryGetListRequest(
    user_id=...,
    include_common_phone_list=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_mobile_phone_number=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_exact_custom_contact_directory=...,
    search_criteria_user_id=...,
    search_criteria_imp_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPhoneDirectoryGetListRequest",
    user_id=...,
    include_common_phone_list=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_mobile_phone_number=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_exact_custom_contact_directory=...,
    search_criteria_user_id=...,
    search_criteria_imp_id=...,
)

print(response)