UserPreferredAnswerEndpointGetListRequest

Bases: OCIRequest

Requests the list of device endpoints of a user that can be configured as Preferred Answer Endpoint for Auto-Answer and Forced Answer. If onlyDisplayPreferredAnswerEndpoint is specified, only the Preferred Answer Endpoint of user is returned in the response.

The response is either UserPreferredAnswerEndpointGetListResponse or ErrorResponse.

Attributes:

user_id (str):

only_display_preferred_answer_endpoint (Optional[bool]):

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

@dataclass(kw_only=True)
class UserPreferredAnswerEndpointGetListRequest(OCIRequest):
    """Requests the list of device endpoints of a user that can be configured
        as Preferred Answer Endpoint for Auto-Answer and Forced Answer.
        If onlyDisplayPreferredAnswerEndpoint is specified, only the
        Preferred Answer Endpoint of user is returned in the response.

        The response is either UserPreferredAnswerEndpointGetListResponse or ErrorResponse.

    Attributes:

        user_id (str):

        only_display_preferred_answer_endpoint (Optional[bool]):

    """

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

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

Responses

Bases: OCIDataResponse

Response to UserPreferredAnswerEndpointGetListRequest. Contains a table of devices associated to a user that can be configured as Preferred Answer Endpoint. The column headings are: "Line Port", "Endpoint Type", "Is Preferred Answer Endpoint", "Device Name", "Device Level", "Device Type". The value of the "Endpoint Type" column is either Primary, Shared Call Appearance or Flexible Seating Guest.

Attributes:

access_device_table (OCITable):

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

@dataclass(kw_only=True)
class UserPreferredAnswerEndpointGetListResponse(OCIDataResponse):
    """Response to UserPreferredAnswerEndpointGetListRequest.
        Contains a table of devices associated to a user that can be configured
        as Preferred Answer Endpoint.
        The column headings are: \"Line Port\", \"Endpoint Type\", \"Is Preferred Answer Endpoint\", \"Device Name\", \"Device Level\", \"Device Type\".
        The value of the \"Endpoint Type\" column is either Primary, Shared Call Appearance or Flexible Seating Guest.

    Attributes:

        access_device_table (OCITable):

    """

    access_device_table: OCITable = field(metadata={"alias": "accessDeviceTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserPreferredAnswerEndpointGetListRequest

client = Client()

command = UserPreferredAnswerEndpointGetListRequest(
    user_id=...,
    only_display_preferred_answer_endpoint=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserPreferredAnswerEndpointGetListRequest",
    user_id=...,
    only_display_preferred_answer_endpoint=...,
)

print(response)