Skip to content

UserSharedCallAppearanceGetEndpointRequest22

Bases: OCIRequest

Get the user's Shared Call Appearance endpoint setting. The response is either a UserSharedCallAppearanceGetEndpointResponse22 or an ErrorResponse.

Attributes:

user_id (str):

access_device_endpoint (AccessDeviceEndpointKey):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserSharedCallAppearanceGetEndpointRequest22(OCIRequest):
    """Get the user's Shared Call Appearance endpoint setting.
        The response is either a UserSharedCallAppearanceGetEndpointResponse22 or an ErrorResponse.

    Attributes:

        user_id (str):

        access_device_endpoint (AccessDeviceEndpointKey):

    """

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

    access_device_endpoint: AccessDeviceEndpointKey = field(
        metadata={"alias": "accessDeviceEndpoint"}
    )

Responses

Bases: OCIDataResponse

Response to the UserSharedCallAppearanceGetEndpointRequest.

The following elements are only used in AS data mode and not returned in XS data mode:
  hotlineContact

The following elements are only used in AS data mode and a value false is returned in the XS mode:
  useHotline

Attributes:

is_active (bool):

allow_origination (bool):

allow_termination (bool):

use_hotline (bool):

hotline_contact (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserSharedCallAppearanceGetEndpointResponse22(OCIDataResponse):
    """Response to the UserSharedCallAppearanceGetEndpointRequest.

        The following elements are only used in AS data mode and not returned in XS data mode:
          hotlineContact

        The following elements are only used in AS data mode and a value false is returned in the XS mode:
          useHotline

    Attributes:

        is_active (bool):

        allow_origination (bool):

        allow_termination (bool):

        use_hotline (bool):

        hotline_contact (Optional[str]):

    """

    is_active: bool = field(metadata={"alias": "isActive"})

    allow_origination: bool = field(metadata={"alias": "allowOrigination"})

    allow_termination: bool = field(metadata={"alias": "allowTermination"})

    use_hotline: bool = field(metadata={"alias": "useHotline"})

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

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 UserSharedCallAppearanceGetEndpointRequest22

client = Client()

command = UserSharedCallAppearanceGetEndpointRequest22(
    user_id=...,
    access_device_endpoint=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserSharedCallAppearanceGetEndpointRequest22",
    user_id=...,
    access_device_endpoint=...,
)

print(response)