Skip to content

UserInterceptUserModifyRequest21sp1

Bases: OCIRequest

Modify the user's intercept user service settings. 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:
  exemptInboundMobilityCalls
  exemptOutboundMobilityCalls
  disableParallelRingingToNetworkLocations

Attributes:

user_id (str):

is_active (Optional[bool]):

announcement_selection (Optional[str]):

audio_file (Optional[LabeledMediaFileResource]):

video_file (Optional[LabeledMediaFileResource]):

inbound_call_mode (Optional[str]):

alternate_blocking_announcement (Optional[bool]):

exempt_inbound_mobility_calls (Optional[bool]):

disable_parallel_ringing_to_network_locations (Optional[bool]):

route_to_voice_mail (Optional[bool]):

play_new_phone_number (Optional[bool]):

new_phone_number (Optional[Nillable[str]]):

transfer_on_zero_to_phone_number (Optional[bool]):

transfer_phone_number (Optional[Nillable[str]]):

outbound_call_mode (Optional[str]):

exempt_outbound_mobility_calls (Optional[bool]):

reroute_outbound_calls (Optional[bool]):

outbound_reroute_phone_number (Optional[Nillable[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserInterceptUserModifyRequest21sp1(OCIRequest):
    """Modify the user's intercept user service settings.
        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:
          exemptInboundMobilityCalls
          exemptOutboundMobilityCalls
          disableParallelRingingToNetworkLocations

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        announcement_selection (Optional[str]):

        audio_file (Optional[LabeledMediaFileResource]):

        video_file (Optional[LabeledMediaFileResource]):

        inbound_call_mode (Optional[str]):

        alternate_blocking_announcement (Optional[bool]):

        exempt_inbound_mobility_calls (Optional[bool]):

        disable_parallel_ringing_to_network_locations (Optional[bool]):

        route_to_voice_mail (Optional[bool]):

        play_new_phone_number (Optional[bool]):

        new_phone_number (Optional[Nillable[str]]):

        transfer_on_zero_to_phone_number (Optional[bool]):

        transfer_phone_number (Optional[Nillable[str]]):

        outbound_call_mode (Optional[str]):

        exempt_outbound_mobility_calls (Optional[bool]):

        reroute_outbound_calls (Optional[bool]):

        outbound_reroute_phone_number (Optional[Nillable[str]]):

    """

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

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

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

    audio_file: Optional[LabeledMediaFileResource] = field(
        default=None, metadata={"alias": "audioFile"}
    )

    video_file: Optional[LabeledMediaFileResource] = field(
        default=None, metadata={"alias": "videoFile"}
    )

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "new_phone_number",
            "transfer_phone_number",
            "outbound_reroute_phone_number",
        ]
        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/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserInterceptUserModifyRequest21sp1

client = Client()

command = UserInterceptUserModifyRequest21sp1(
    user_id=...,
    is_active=...,
    announcement_selection=...,
    audio_file=...,
    video_file=...,
    inbound_call_mode=...,
    alternate_blocking_announcement=...,
    exempt_inbound_mobility_calls=...,
    disable_parallel_ringing_to_network_locations=...,
    route_to_voice_mail=...,
    play_new_phone_number=...,
    new_phone_number=...,
    transfer_on_zero_to_phone_number=...,
    transfer_phone_number=...,
    outbound_call_mode=...,
    exempt_outbound_mobility_calls=...,
    reroute_outbound_calls=...,
    outbound_reroute_phone_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserInterceptUserModifyRequest21sp1",
    user_id=...,
    is_active=...,
    announcement_selection=...,
    audio_file=...,
    video_file=...,
    inbound_call_mode=...,
    alternate_blocking_announcement=...,
    exempt_inbound_mobility_calls=...,
    disable_parallel_ringing_to_network_locations=...,
    route_to_voice_mail=...,
    play_new_phone_number=...,
    new_phone_number=...,
    transfer_on_zero_to_phone_number=...,
    transfer_phone_number=...,
    outbound_call_mode=...,
    exempt_outbound_mobility_calls=...,
    reroute_outbound_calls=...,
    outbound_reroute_phone_number=...,
)

print(response)