Skip to content

UserSharedCallAppearanceModifyRequest

Bases: OCIRequest

Modify the user's Shared Call Appearance service setting. The response is either a SuccessResponse or an ErrorResponse.

 The following elements are only used in XS data mode and ignored in AS data mode:
   useUserPrimaryWithAlternateCallsSetting
   allowSimultaneousPrimaryAndAlternate
   restrictCallRetrieveOfPrimary
   restrictCallBridgingOfPrimary

Attributes:

user_id (str):

alert_all_appearances_for_click_to_dial_calls (Optional[bool]):

alert_all_appearances_for_group_paging_calls (Optional[bool]):

allow_sca_call_retrieve (Optional[bool]):

multiple_call_arrangement_is_active (Optional[bool]):

allow_bridging_between_locations (Optional[bool]):

bridge_warning_tone (Optional[str]):

enable_call_park_notification (Optional[bool]):

use_user_primary_with_alternate_calls_setting (Optional[bool]):

allow_simultaneous_primary_and_alternate_calls (Optional[bool]):

restrict_call_retrieve_of_primary_call (Optional[bool]):

restrict_call_bridging_of_primary_call (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserSharedCallAppearanceModifyRequest(OCIRequest):
    """Modify the user's Shared Call Appearance service setting.
         The response is either a SuccessResponse or an ErrorResponse.

         The following elements are only used in XS data mode and ignored in AS data mode:
           useUserPrimaryWithAlternateCallsSetting
           allowSimultaneousPrimaryAndAlternate
           restrictCallRetrieveOfPrimary
           restrictCallBridgingOfPrimary

    Attributes:

        user_id (str):

        alert_all_appearances_for_click_to_dial_calls (Optional[bool]):

        alert_all_appearances_for_group_paging_calls (Optional[bool]):

        allow_sca_call_retrieve (Optional[bool]):

        multiple_call_arrangement_is_active (Optional[bool]):

        allow_bridging_between_locations (Optional[bool]):

        bridge_warning_tone (Optional[str]):

        enable_call_park_notification (Optional[bool]):

        use_user_primary_with_alternate_calls_setting (Optional[bool]):

        allow_simultaneous_primary_and_alternate_calls (Optional[bool]):

        restrict_call_retrieve_of_primary_call (Optional[bool]):

        restrict_call_bridging_of_primary_call (Optional[bool]):

    """

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

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

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

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

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

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

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

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

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

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

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

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

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 UserSharedCallAppearanceModifyRequest

client = Client()

command = UserSharedCallAppearanceModifyRequest(
    user_id=...,
    alert_all_appearances_for_click_to_dial_calls=...,
    alert_all_appearances_for_group_paging_calls=...,
    allow_sca_call_retrieve=...,
    multiple_call_arrangement_is_active=...,
    allow_bridging_between_locations=...,
    bridge_warning_tone=...,
    enable_call_park_notification=...,
    use_user_primary_with_alternate_calls_setting=...,
    allow_simultaneous_primary_and_alternate_calls=...,
    restrict_call_retrieve_of_primary_call=...,
    restrict_call_bridging_of_primary_call=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserSharedCallAppearanceModifyRequest",
    user_id=...,
    alert_all_appearances_for_click_to_dial_calls=...,
    alert_all_appearances_for_group_paging_calls=...,
    allow_sca_call_retrieve=...,
    multiple_call_arrangement_is_active=...,
    allow_bridging_between_locations=...,
    bridge_warning_tone=...,
    enable_call_park_notification=...,
    use_user_primary_with_alternate_calls_setting=...,
    allow_simultaneous_primary_and_alternate_calls=...,
    restrict_call_retrieve_of_primary_call=...,
    restrict_call_bridging_of_primary_call=...,
)

print(response)