UserPhoneDirectoryGetSearchedListRequest

Bases: OCIRequest

Request a table containing the phone directory for a user. If the specified user 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 user's group. If the specified user is part of a service provider, the directory includes all users in the user's group and all entries in the common phone list of the specified user's group. It is possible to search the directory for names containing a specified search string. The search includes matches on first name or last name or common phone list names. The response is either UserPhoneDirectoryGetSearchedListResponse or ErrorResponse.

Attributes:

user_id (str):

name_search_string (Optional[str]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserPhoneDirectoryGetSearchedListRequest(OCIRequest):
    """Request a table containing the phone directory for a user.
        If the specified user 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 user's group.
        If the specified user is part of a service provider, the directory includes all users in the user's group
        and all entries in the common phone list of the specified user's group.
        It is possible to search the directory for names containing a specified search string. The search includes
        matches on first name or last name or common phone list names.
        The response is either UserPhoneDirectoryGetSearchedListResponse or ErrorResponse.

    Attributes:

        user_id (str):

        name_search_string (Optional[str]):

    """

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

    name_search_string: Optional[str] = field(
        default=None, metadata={"alias": "nameSearchString"}
    )

Responses

Bases: OCIDataResponse

Response to UserPhoneDirectoryGetSearchedListRequest. 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", "Hiragana Name", "Group Id", "Yahoo Id", "User Id", "IMP Id", "First Name", "Last Name", "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 UserPhoneDirectoryGetSearchedListResponse(OCIDataResponse):
    """Response to UserPhoneDirectoryGetSearchedListRequest.
        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\",
        \"Hiragana Name\", \"Group Id\", \"Yahoo Id\", \"User Id\", \"IMP Id\", \"First Name\", \"Last Name\",
        \"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

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserPhoneDirectoryGetSearchedListRequest

client = Client()

command = UserPhoneDirectoryGetSearchedListRequest(
    user_id=...,
    name_search_string=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPhoneDirectoryGetSearchedListRequest",
    user_id=...,
    name_search_string=...,
)

print(response)