Skip to content

UserBroadWorksMobilityMobileIdentityModifyRequest

Bases: OCIRequest

Modify the settings for one of the user's BroadWorks Mobility mobile Identities. The response is either a SuccessResponse or an ErrorResponse. The request fails when enableAlerting or timeSchedule or holidaySchedule are included in the request when the user's use mobile identity call anchoring controls is disabled.

The description, enableAlerting, alertAgentCalls, alertClickToDialCalls, alertGroupPagingCalls, useMobilityCallingLineID, enableDiversionInhibitor, requireAnswerConfirmation, broadworksCallControl, devicesToRing, includeSharedCallAppearance, includeBroadworksAnywhere, includeExecutiveAssistance, mobileNumberAlerted, enableCallAnchoring, timeSchedule, holidaySchedule and useMobilityConnectedIdentity parameters require an authorization level of User for modification when the BroadWorks Mobility service is on.
The isPrimary, useSettingLevel, denyCallOrigination, denyCallTerminations, accessDeviceEndpoint, outboundAlternateNumber, enableDirectRouting, markCDRAsEnterpriseGroupCalls and networkTranslationIndex  parameters require an authorization level of Group for modification.

Attributes:

user_id (str):

mobile_number (str):

description (Optional[Nillable[str]]):

is_primary (Optional[bool]):

enable_alerting (Optional[bool]):

alert_agent_calls (Optional[bool]):

alert_click_to_dial_calls (Optional[bool]):

alert_group_paging_calls (Optional[bool]):

use_mobility_calling_line_id (Optional[bool]):

enable_diversion_inhibitor (Optional[bool]):

require_answer_confirmation (Optional[bool]):

broadworks_call_control (Optional[bool]):

use_setting_level (Optional[str]):

deny_call_originations (Optional[bool]):

deny_call_terminations (Optional[bool]):

devices_to_ring (Optional[str]):

include_shared_call_appearance (Optional[bool]):

include_broadworks_anywhere (Optional[bool]):

include_executive_assistant (Optional[bool]):

mobile_numbers_alerted (Optional[Nillable[BroadWorksMobilityAlertingMobileNumberReplacementList]]):

enable_call_anchoring (Optional[bool]):

time_schedule (Optional[Nillable[ScheduleGlobalKey]]):

holiday_schedule (Optional[Nillable[ScheduleGlobalKey]]):

access_device_endpoint (Optional[Nillable[AccessDeviceEndpointAndHotlineModify]]):

outbound_alternate_number (Optional[Nillable[str]]):

enable_direct_routing (Optional[bool]):

mark_cdr_as_enterprise_group_calls (Optional[bool]):

use_mobility_connected_identity (Optional[bool]):

network_translation_index (Optional[Nillable[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksMobilityMobileIdentityModifyRequest(OCIRequest):
    """Modify the settings for one of the user's BroadWorks Mobility mobile Identities.
        The response is either a SuccessResponse or an ErrorResponse.
        The request fails when enableAlerting or timeSchedule or holidaySchedule are included in the request when the user's use mobile identity call anchoring controls is disabled.

        The description, enableAlerting, alertAgentCalls, alertClickToDialCalls, alertGroupPagingCalls, useMobilityCallingLineID, enableDiversionInhibitor, requireAnswerConfirmation, broadworksCallControl, devicesToRing, includeSharedCallAppearance, includeBroadworksAnywhere, includeExecutiveAssistance, mobileNumberAlerted, enableCallAnchoring, timeSchedule, holidaySchedule and useMobilityConnectedIdentity parameters require an authorization level of User for modification when the BroadWorks Mobility service is on.
        The isPrimary, useSettingLevel, denyCallOrigination, denyCallTerminations, accessDeviceEndpoint, outboundAlternateNumber, enableDirectRouting, markCDRAsEnterpriseGroupCalls and networkTranslationIndex  parameters require an authorization level of Group for modification.

    Attributes:

        user_id (str):

        mobile_number (str):

        description (Optional[Nillable[str]]):

        is_primary (Optional[bool]):

        enable_alerting (Optional[bool]):

        alert_agent_calls (Optional[bool]):

        alert_click_to_dial_calls (Optional[bool]):

        alert_group_paging_calls (Optional[bool]):

        use_mobility_calling_line_id (Optional[bool]):

        enable_diversion_inhibitor (Optional[bool]):

        require_answer_confirmation (Optional[bool]):

        broadworks_call_control (Optional[bool]):

        use_setting_level (Optional[str]):

        deny_call_originations (Optional[bool]):

        deny_call_terminations (Optional[bool]):

        devices_to_ring (Optional[str]):

        include_shared_call_appearance (Optional[bool]):

        include_broadworks_anywhere (Optional[bool]):

        include_executive_assistant (Optional[bool]):

        mobile_numbers_alerted (Optional[Nillable[BroadWorksMobilityAlertingMobileNumberReplacementList]]):

        enable_call_anchoring (Optional[bool]):

        time_schedule (Optional[Nillable[ScheduleGlobalKey]]):

        holiday_schedule (Optional[Nillable[ScheduleGlobalKey]]):

        access_device_endpoint (Optional[Nillable[AccessDeviceEndpointAndHotlineModify]]):

        outbound_alternate_number (Optional[Nillable[str]]):

        enable_direct_routing (Optional[bool]):

        mark_cdr_as_enterprise_group_calls (Optional[bool]):

        use_mobility_connected_identity (Optional[bool]):

        network_translation_index (Optional[Nillable[str]]):

    """

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    mobile_numbers_alerted: Optional[
        Nillable[BroadWorksMobilityAlertingMobileNumberReplacementList]
    ] = field(default=None, metadata={"alias": "mobileNumbersAlerted"})

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "description",
            "mobile_numbers_alerted",
            "time_schedule",
            "holiday_schedule",
            "access_device_endpoint",
            "outbound_alternate_number",
            "network_translation_index",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

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 UserBroadWorksMobilityMobileIdentityModifyRequest

client = Client()

command = UserBroadWorksMobilityMobileIdentityModifyRequest(
    user_id=...,
    mobile_number=...,
    description=...,
    is_primary=...,
    enable_alerting=...,
    alert_agent_calls=...,
    alert_click_to_dial_calls=...,
    alert_group_paging_calls=...,
    use_mobility_calling_line_id=...,
    enable_diversion_inhibitor=...,
    require_answer_confirmation=...,
    broadworks_call_control=...,
    use_setting_level=...,
    deny_call_originations=...,
    deny_call_terminations=...,
    devices_to_ring=...,
    include_shared_call_appearance=...,
    include_broadworks_anywhere=...,
    include_executive_assistant=...,
    mobile_numbers_alerted=...,
    enable_call_anchoring=...,
    time_schedule=...,
    holiday_schedule=...,
    access_device_endpoint=...,
    outbound_alternate_number=...,
    enable_direct_routing=...,
    mark_cdr_as_enterprise_group_calls=...,
    use_mobility_connected_identity=...,
    network_translation_index=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserBroadWorksMobilityMobileIdentityModifyRequest",
    user_id=...,
    mobile_number=...,
    description=...,
    is_primary=...,
    enable_alerting=...,
    alert_agent_calls=...,
    alert_click_to_dial_calls=...,
    alert_group_paging_calls=...,
    use_mobility_calling_line_id=...,
    enable_diversion_inhibitor=...,
    require_answer_confirmation=...,
    broadworks_call_control=...,
    use_setting_level=...,
    deny_call_originations=...,
    deny_call_terminations=...,
    devices_to_ring=...,
    include_shared_call_appearance=...,
    include_broadworks_anywhere=...,
    include_executive_assistant=...,
    mobile_numbers_alerted=...,
    enable_call_anchoring=...,
    time_schedule=...,
    holiday_schedule=...,
    access_device_endpoint=...,
    outbound_alternate_number=...,
    enable_direct_routing=...,
    mark_cdr_as_enterprise_group_calls=...,
    use_mobility_connected_identity=...,
    network_translation_index=...,
)

print(response)