Skip to content

UserPolycomPhoneServicesGetRequest

Bases: OCIRequest

Request the user's Polycom Phone Services attributes. The response is either a UserPolycomPhoneServicesGetResponse or an ErrorResponse.

Attributes:

user_id (str):

access_device (AccessDevice):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPolycomPhoneServicesGetRequest(OCIRequest):
    """Request the user's Polycom Phone Services attributes.
        The response is either a UserPolycomPhoneServicesGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        access_device (AccessDevice):

    """

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

    access_device: AccessDevice = field(metadata={"alias": "accessDevice"})

Responses

Bases: OCIDataResponse

Response to UserPolycomPhoneServicesGetRequest.

Attributes:

integrate_phone_directory_with_broad_works (bool):

include_user_personal_phone_list_in_directory (bool):

include_group_custom_contact_directory_in_directory (bool):

group_custom_contact_directory (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPolycomPhoneServicesGetResponse(OCIDataResponse):
    """Response to UserPolycomPhoneServicesGetRequest.

    Attributes:

        integrate_phone_directory_with_broad_works (bool):

        include_user_personal_phone_list_in_directory (bool):

        include_group_custom_contact_directory_in_directory (bool):

        group_custom_contact_directory (Optional[str]):

    """

    integrate_phone_directory_with_broad_works: bool = field(
        metadata={"alias": "integratePhoneDirectoryWithBroadWorks"}
    )

    include_user_personal_phone_list_in_directory: bool = field(
        metadata={"alias": "includeUserPersonalPhoneListInDirectory"}
    )

    include_group_custom_contact_directory_in_directory: bool = field(
        metadata={"alias": "includeGroupCustomContactDirectoryInDirectory"}
    )

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

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 UserPolycomPhoneServicesGetRequest

client = Client()

command = UserPolycomPhoneServicesGetRequest(
    user_id=...,
    access_device=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPolycomPhoneServicesGetRequest",
    user_id=...,
    access_device=...,
)

print(response)