UserSharedCallAppearanceAddEndpointRequest22

Bases: OCIRequest

Associate an access device instance to the user's Shared Call Appearance.

The following elements are ignored in XS data mode:
  allowVideo, useValue true in AS data mode

The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

access_device_endpoint (AccessDeviceEndpointAndHotlineAdd):

is_active (bool):

allow_origination (bool):

allow_termination (bool):

allow_video (bool):

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

@dataclass(kw_only=True)
class UserSharedCallAppearanceAddEndpointRequest22(OCIRequest):
    """Associate an access device instance to the user's Shared Call Appearance.

        The following elements are ignored in XS data mode:
          allowVideo, useValue true in AS data mode

        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        access_device_endpoint (AccessDeviceEndpointAndHotlineAdd):

        is_active (bool):

        allow_origination (bool):

        allow_termination (bool):

        allow_video (bool):

    """

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

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

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

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

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

    allow_video: bool = field(metadata={"alias": "allowVideo"})

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 UserSharedCallAppearanceAddEndpointRequest22

client = Client()

command = UserSharedCallAppearanceAddEndpointRequest22(
    user_id=...,
    access_device_endpoint=...,
    is_active=...,
    allow_origination=...,
    allow_termination=...,
    allow_video=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserSharedCallAppearanceAddEndpointRequest22",
    user_id=...,
    access_device_endpoint=...,
    is_active=...,
    allow_origination=...,
    allow_termination=...,
    allow_video=...,
)

print(response)