Skip to content

UserExecutiveGetScreeningAlertingRequest

Bases: OCIRequest

Get the screening and alerting setting of an executive. Both executive and the executive assistant can run this command. The response is either UserExecutiveGetScreeningAlertingResponse or ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserExecutiveGetScreeningAlertingRequest(OCIRequest):
    """Get the screening and alerting setting of an executive. Both executive and the executive assistant can run this command.
        The response is either UserExecutiveGetScreeningAlertingResponse or ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserExecutiveGetScreeningAlertingRequest. Contains the screening and alerting settings for an executive.

Attributes:

enable_screening (bool):

screening_alert_type (str):

alert_broad_works_mobility_location (bool):

alert_broad_works_anywhere_locations (bool):

alert_shared_call_appearance_locations (bool):

alerting_mode (str):

alerting_calling_line_id_name_mode (str):

alerting_custom_calling_line_id_name (Optional[str]):

unicode_alerting_custom_calling_line_id_name (Optional[str]):

alerting_calling_line_id_phone_number_mode (str):

alerting_custom_calling_line_id_phone_number (Optional[str]):

call_push_recall_number_of_rings (int):

next_assistant_number_of_rings (int):

enable_rollover (bool):

rollover_wait_time_seconds (Optional[int]):

rollover_action (str):

rollover_forward_to_phone_number (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserExecutiveGetScreeningAlertingResponse(OCIDataResponse):
    """Response to the UserExecutiveGetScreeningAlertingRequest.
        Contains the screening and alerting settings for an executive.

    Attributes:

        enable_screening (bool):

        screening_alert_type (str):

        alert_broad_works_mobility_location (bool):

        alert_broad_works_anywhere_locations (bool):

        alert_shared_call_appearance_locations (bool):

        alerting_mode (str):

        alerting_calling_line_id_name_mode (str):

        alerting_custom_calling_line_id_name (Optional[str]):

        unicode_alerting_custom_calling_line_id_name (Optional[str]):

        alerting_calling_line_id_phone_number_mode (str):

        alerting_custom_calling_line_id_phone_number (Optional[str]):

        call_push_recall_number_of_rings (int):

        next_assistant_number_of_rings (int):

        enable_rollover (bool):

        rollover_wait_time_seconds (Optional[int]):

        rollover_action (str):

        rollover_forward_to_phone_number (Optional[str]):

    """

    enable_screening: bool = field(metadata={"alias": "enableScreening"})

    screening_alert_type: str = field(metadata={"alias": "screeningAlertType"})

    alert_broad_works_mobility_location: bool = field(
        metadata={"alias": "alertBroadWorksMobilityLocation"}
    )

    alert_broad_works_anywhere_locations: bool = field(
        metadata={"alias": "alertBroadWorksAnywhereLocations"}
    )

    alert_shared_call_appearance_locations: bool = field(
        metadata={"alias": "alertSharedCallAppearanceLocations"}
    )

    alerting_mode: str = field(metadata={"alias": "alertingMode"})

    alerting_calling_line_id_name_mode: str = field(
        metadata={"alias": "alertingCallingLineIdNameMode"}
    )

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

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

    alerting_calling_line_id_phone_number_mode: str = field(
        metadata={"alias": "alertingCallingLineIdPhoneNumberMode"}
    )

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

    call_push_recall_number_of_rings: int = field(
        metadata={"alias": "callPushRecallNumberOfRings"}
    )

    next_assistant_number_of_rings: int = field(
        metadata={"alias": "nextAssistantNumberOfRings"}
    )

    enable_rollover: bool = field(metadata={"alias": "enableRollover"})

    rollover_wait_time_seconds: Optional[int] = field(
        default=None, metadata={"alias": "rolloverWaitTimeSeconds"}
    )

    rollover_action: str = field(metadata={"alias": "rolloverAction"})

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

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 UserExecutiveGetScreeningAlertingRequest

client = Client()

command = UserExecutiveGetScreeningAlertingRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserExecutiveGetScreeningAlertingRequest",
    user_id=...,
)

print(response)