Skip to content

UserBroadWorksMobilityMobileIdentityGetRequest22V3

Bases: OCIRequest

Get the settings for a user's specified mobile identity. The response is either a UserBroadWorksMobilityMobileIdentityGetResponse22V3 or an ErrorResponse.

Attributes:

user_id (str):

mobile_number (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksMobilityMobileIdentityGetRequest22V3(OCIRequest):
    """Get the settings for a user's specified mobile identity.
        The response is either a UserBroadWorksMobilityMobileIdentityGetResponse22V3 or an ErrorResponse.

    Attributes:

        user_id (str):

        mobile_number (str):

    """

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

    mobile_number: str = field(metadata={"alias": "mobileNumber"})

Responses

Bases: OCIDataResponse

Response to a UserBroadWorksMobilityMobileIdentityGetRequest22V3.

 Columns for the mobileNumberAlertedTable are as follows: "Mobile Number", "Country Code", "National Prefix"

Attributes:

description (Optional[str]):

is_primary (bool):

enable_alerting (bool):

alert_agent_calls (bool):

alert_click_to_dial_calls (bool):

alert_group_paging_calls (bool):

use_mobility_calling_line_id (bool):

enable_diversion_inhibitor (bool):

require_answer_confirmation (bool):

broadworks_call_control (bool):

use_setting_level (str):

deny_call_originations (bool):

deny_call_terminations (bool):

effective_enable_location_services (bool):

effective_enable_msrn_lookup (bool):

effective_enable_mobile_state_checking (bool):

effective_enable_announcement_suppression (bool):

effective_deny_call_originations (bool):

effective_deny_call_terminations (bool):

devices_to_ring (str):

include_shared_call_appearance (bool):

include_broadworks_anywhere (bool):

include_executive_assistant (bool):

enable_call_anchoring (bool):

time_schedule (Optional[ScheduleGlobalKey]):

holiday_schedule (Optional[ScheduleGlobalKey]):

access_device_endpoint (Optional[AccessDeviceEndpointWithPortNumberRead22V2]):

outbound_alternate_number (Optional[str]):

enable_direct_routing (bool):

mark_cdr_as_enterprise_group_calls (bool):

use_mobility_connected_identity (bool):

network_translation_index (Optional[str]):

mobile_number_alerted_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksMobilityMobileIdentityGetResponse22V3(OCIDataResponse):
    """Response to a UserBroadWorksMobilityMobileIdentityGetRequest22V3.


         Columns for the mobileNumberAlertedTable are as follows: \"Mobile Number\", \"Country Code\", \"National Prefix\"

    Attributes:

        description (Optional[str]):

        is_primary (bool):

        enable_alerting (bool):

        alert_agent_calls (bool):

        alert_click_to_dial_calls (bool):

        alert_group_paging_calls (bool):

        use_mobility_calling_line_id (bool):

        enable_diversion_inhibitor (bool):

        require_answer_confirmation (bool):

        broadworks_call_control (bool):

        use_setting_level (str):

        deny_call_originations (bool):

        deny_call_terminations (bool):

        effective_enable_location_services (bool):

        effective_enable_msrn_lookup (bool):

        effective_enable_mobile_state_checking (bool):

        effective_enable_announcement_suppression (bool):

        effective_deny_call_originations (bool):

        effective_deny_call_terminations (bool):

        devices_to_ring (str):

        include_shared_call_appearance (bool):

        include_broadworks_anywhere (bool):

        include_executive_assistant (bool):

        enable_call_anchoring (bool):

        time_schedule (Optional[ScheduleGlobalKey]):

        holiday_schedule (Optional[ScheduleGlobalKey]):

        access_device_endpoint (Optional[AccessDeviceEndpointWithPortNumberRead22V2]):

        outbound_alternate_number (Optional[str]):

        enable_direct_routing (bool):

        mark_cdr_as_enterprise_group_calls (bool):

        use_mobility_connected_identity (bool):

        network_translation_index (Optional[str]):

        mobile_number_alerted_table (OCITable):

    """

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

    is_primary: bool = field(metadata={"alias": "isPrimary"})

    enable_alerting: bool = field(metadata={"alias": "enableAlerting"})

    alert_agent_calls: bool = field(metadata={"alias": "alertAgentCalls"})

    alert_click_to_dial_calls: bool = field(metadata={"alias": "alertClickToDialCalls"})

    alert_group_paging_calls: bool = field(metadata={"alias": "alertGroupPagingCalls"})

    use_mobility_calling_line_id: bool = field(
        metadata={"alias": "useMobilityCallingLineID"}
    )

    enable_diversion_inhibitor: bool = field(
        metadata={"alias": "enableDiversionInhibitor"}
    )

    require_answer_confirmation: bool = field(
        metadata={"alias": "requireAnswerConfirmation"}
    )

    broadworks_call_control: bool = field(metadata={"alias": "broadworksCallControl"})

    use_setting_level: str = field(metadata={"alias": "useSettingLevel"})

    deny_call_originations: bool = field(metadata={"alias": "denyCallOriginations"})

    deny_call_terminations: bool = field(metadata={"alias": "denyCallTerminations"})

    effective_enable_location_services: bool = field(
        metadata={"alias": "effectiveEnableLocationServices"}
    )

    effective_enable_msrn_lookup: bool = field(
        metadata={"alias": "effectiveEnableMSRNLookup"}
    )

    effective_enable_mobile_state_checking: bool = field(
        metadata={"alias": "effectiveEnableMobileStateChecking"}
    )

    effective_enable_announcement_suppression: bool = field(
        metadata={"alias": "effectiveEnableAnnouncementSuppression"}
    )

    effective_deny_call_originations: bool = field(
        metadata={"alias": "effectiveDenyCallOriginations"}
    )

    effective_deny_call_terminations: bool = field(
        metadata={"alias": "effectiveDenyCallTerminations"}
    )

    devices_to_ring: str = field(metadata={"alias": "devicesToRing"})

    include_shared_call_appearance: bool = field(
        metadata={"alias": "includeSharedCallAppearance"}
    )

    include_broadworks_anywhere: bool = field(
        metadata={"alias": "includeBroadworksAnywhere"}
    )

    include_executive_assistant: bool = field(
        metadata={"alias": "includeExecutiveAssistant"}
    )

    enable_call_anchoring: bool = field(metadata={"alias": "enableCallAnchoring"})

    time_schedule: Optional[ScheduleGlobalKey] = field(
        default=None, metadata={"alias": "timeSchedule"}
    )

    holiday_schedule: Optional[ScheduleGlobalKey] = field(
        default=None, metadata={"alias": "holidaySchedule"}
    )

    access_device_endpoint: Optional[AccessDeviceEndpointWithPortNumberRead22V2] = (
        field(default=None, metadata={"alias": "accessDeviceEndpoint"})
    )

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

    enable_direct_routing: bool = field(metadata={"alias": "enableDirectRouting"})

    mark_cdr_as_enterprise_group_calls: bool = field(
        metadata={"alias": "markCDRAsEnterpriseGroupCalls"}
    )

    use_mobility_connected_identity: bool = field(
        metadata={"alias": "useMobilityConnectedIdentity"}
    )

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

    mobile_number_alerted_table: OCITable = field(
        metadata={"alias": "mobileNumberAlertedTable"}
    )

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 UserBroadWorksMobilityMobileIdentityGetRequest22V3

client = Client()

command = UserBroadWorksMobilityMobileIdentityGetRequest22V3(
    user_id=...,
    mobile_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserBroadWorksMobilityMobileIdentityGetRequest22V3",
    user_id=...,
    mobile_number=...,
)

print(response)