Skip to content

UserBroadworksMobilityAddMobileIdentityUsingSharedCallAppearanceRequest22

Bases: OCIRequest

Adding a new mobile identity using the Share Call Appearance. The response is either a SuccessResponse or an ErrorResponse.

The following elements are only used in AS data mode and ignored in XS data mode:
  useHotline, use value false in XS data mode
  hotlineContact

The request fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is empty.

Attributes:

user_id (str):

access_device_endpoint (AccessDeviceEndpointKey):

mobile_number (str):

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):

devices_to_ring (str):

include_shared_call_appearance (bool):

include_broadworks_anywhere (bool):

include_executive_assistant (bool):

mobile_number_alerted (Optional[List[str]]):

enable_call_anchoring (bool):

time_schedule (Optional[ScheduleGlobalKey]):

holiday_schedule (Optional[ScheduleGlobalKey]):

enable_direct_routing (bool):

mark_cdr_as_enterprise_group_calls (bool):

use_hotline (bool):

hotline_contact (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadworksMobilityAddMobileIdentityUsingSharedCallAppearanceRequest22(
    OCIRequest
):
    """Adding a new mobile identity using the Share Call Appearance.
        The response is either a SuccessResponse or an ErrorResponse.

        The following elements are only used in AS data mode and ignored in XS data mode:
          useHotline, use value false in XS data mode
          hotlineContact

        The request fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is empty.

    Attributes:

        user_id (str):

        access_device_endpoint (AccessDeviceEndpointKey):

        mobile_number (str):

        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):

        devices_to_ring (str):

        include_shared_call_appearance (bool):

        include_broadworks_anywhere (bool):

        include_executive_assistant (bool):

        mobile_number_alerted (Optional[List[str]]):

        enable_call_anchoring (bool):

        time_schedule (Optional[ScheduleGlobalKey]):

        holiday_schedule (Optional[ScheduleGlobalKey]):

        enable_direct_routing (bool):

        mark_cdr_as_enterprise_group_calls (bool):

        use_hotline (bool):

        hotline_contact (Optional[str]):

    """

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

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

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

    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"})

    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"}
    )

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

    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"}
    )

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

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

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

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

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 UserBroadworksMobilityAddMobileIdentityUsingSharedCallAppearanceRequest22

client = Client()

command = UserBroadworksMobilityAddMobileIdentityUsingSharedCallAppearanceRequest22(
    user_id=...,
    access_device_endpoint=...,
    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_number_alerted=...,
    enable_call_anchoring=...,
    time_schedule=...,
    holiday_schedule=...,
    enable_direct_routing=...,
    mark_cdr_as_enterprise_group_calls=...,
    use_hotline=...,
    hotline_contact=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserBroadworksMobilityAddMobileIdentityUsingSharedCallAppearanceRequest22",
    user_id=...,
    access_device_endpoint=...,
    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_number_alerted=...,
    enable_call_anchoring=...,
    time_schedule=...,
    holiday_schedule=...,
    enable_direct_routing=...,
    mark_cdr_as_enterprise_group_calls=...,
    use_hotline=...,
    hotline_contact=...,
)

print(response)