Skip to content

UserVoiceMessagingUserModifyVoiceManagementRequest23

Bases: OCIRequest

Modify the user's voice messaging voice management service setting. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

is_active (Optional[bool]):

processing (Optional[str]):

voice_message_delivery_email_address (Optional[Nillable[EmailAddressList]]):

use_phone_message_waiting_indicator (Optional[bool]):

send_voice_message_notify_email (Optional[bool]):

voice_message_notify_email_address (Optional[Nillable[str]]):

send_carbon_copy_voice_message (Optional[bool]):

voice_message_carbon_copy_email_address (Optional[Nillable[str]]):

transfer_on_zero_to_phone_number (Optional[bool]):

transfer_phone_number (Optional[Nillable[str]]):

always_redirect_to_voice_mail (Optional[bool]):

busy_redirect_to_voice_mail (Optional[bool]):

no_answer_redirect_to_voice_mail (Optional[bool]):

out_of_primary_zone_redirect_to_voice_mail (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserVoiceMessagingUserModifyVoiceManagementRequest23(OCIRequest):
    """Modify the user's voice messaging voice management service setting.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        processing (Optional[str]):

        voice_message_delivery_email_address (Optional[Nillable[EmailAddressList]]):

        use_phone_message_waiting_indicator (Optional[bool]):

        send_voice_message_notify_email (Optional[bool]):

        voice_message_notify_email_address (Optional[Nillable[str]]):

        send_carbon_copy_voice_message (Optional[bool]):

        voice_message_carbon_copy_email_address (Optional[Nillable[str]]):

        transfer_on_zero_to_phone_number (Optional[bool]):

        transfer_phone_number (Optional[Nillable[str]]):

        always_redirect_to_voice_mail (Optional[bool]):

        busy_redirect_to_voice_mail (Optional[bool]):

        no_answer_redirect_to_voice_mail (Optional[bool]):

        out_of_primary_zone_redirect_to_voice_mail (Optional[bool]):

    """

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

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

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

    voice_message_delivery_email_address: Optional[Nillable[EmailAddressList]] = field(
        default=None, metadata={"alias": "voiceMessageDeliveryEmailAddress"}
    )

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "voice_message_delivery_email_address",
            "voice_message_notify_email_address",
            "voice_message_carbon_copy_email_address",
            "transfer_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 UserVoiceMessagingUserModifyVoiceManagementRequest23

client = Client()

command = UserVoiceMessagingUserModifyVoiceManagementRequest23(
    user_id=...,
    is_active=...,
    processing=...,
    voice_message_delivery_email_address=...,
    use_phone_message_waiting_indicator=...,
    send_voice_message_notify_email=...,
    voice_message_notify_email_address=...,
    send_carbon_copy_voice_message=...,
    voice_message_carbon_copy_email_address=...,
    transfer_on_zero_to_phone_number=...,
    transfer_phone_number=...,
    always_redirect_to_voice_mail=...,
    busy_redirect_to_voice_mail=...,
    no_answer_redirect_to_voice_mail=...,
    out_of_primary_zone_redirect_to_voice_mail=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserVoiceMessagingUserModifyVoiceManagementRequest23",
    user_id=...,
    is_active=...,
    processing=...,
    voice_message_delivery_email_address=...,
    use_phone_message_waiting_indicator=...,
    send_voice_message_notify_email=...,
    voice_message_notify_email_address=...,
    send_carbon_copy_voice_message=...,
    voice_message_carbon_copy_email_address=...,
    transfer_on_zero_to_phone_number=...,
    transfer_phone_number=...,
    always_redirect_to_voice_mail=...,
    busy_redirect_to_voice_mail=...,
    no_answer_redirect_to_voice_mail=...,
    out_of_primary_zone_redirect_to_voice_mail=...,
)

print(response)