Skip to content

SystemVoiceMessagingGroupModifyRequestRI

Bases: OCIRequest

Modify the system level data associated with Voice Messaging. The response is either a SuccessResponse or an ErrorResponse.

The following elements are only used in AS data mode:
   realDeleteForImap
   useDnInMailBody
   useShortSubjectLine
   maxMessageLengthMinutes
   maxMailboxLengthMinutes
   doesMessageAge
   holdPeriodDays
   mailServerNetAddress
   mailServerProtocol
   defaultDeliveryFromAddress
   defaultNotificationFromAddress
   useOutgoingMWIOnSMDI
   mwiDelayInSeconds
   voicePortalScope
   enterpriseVoicePortalLicensed
   networkWideMessaging
   useExternalRouting
   defaultExternalRoutingAddress
   vmOnlySystem
   clientInitiatedMailServerSessionTimeoutMinutes
   recordingAudioFileFormat
   allowVoicePortalAccessFromVMDepositMenu
   allowVoicePortalAutoLoginForMobileDevicesOnly
   selectMwiTemplatePerCaller

Attributes:

real_delete_for_imap (Optional[bool]):

use_dn_in_mail_body (Optional[bool]):

use_short_subject_line (Optional[bool]):

max_message_length_minutes (Optional[int]):

max_mailbox_length_minutes (Optional[int]):

does_message_age (Optional[bool]):

hold_period_days (Optional[int]):

mail_server_net_address (Optional[Nillable[str]]):

mail_server_protocol (Optional[str]):

default_delivery_from_address (Optional[str]):

default_notification_from_address (Optional[str]):

default_voice_portal_lockout_from_address (Optional[str]):

use_outgoing_mwi_on_smdi (Optional[bool]):

mwi_delay_in_seconds (Optional[int]):

voice_portal_scope (Optional[str]):

network_wide_messaging (Optional[bool]):

use_external_routing (Optional[bool]):

default_external_routing_address (Optional[Nillable[str]]):

vm_only_system (Optional[bool]):

client_initiated_mail_server_session_timeout_minutes (Optional[int]):

recording_audio_file_format (Optional[str]):

allow_voice_portal_access_from_vm_deposit_menu (Optional[bool]):

allow_voice_portal_auto_login_for_mobile_devices_only (Optional[bool]):

select_mwi_template_per_caller (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemVoiceMessagingGroupModifyRequestRI(OCIRequest):
    """Modify the system level data associated with Voice Messaging.
        The response is either a SuccessResponse or an ErrorResponse.

        The following elements are only used in AS data mode:
           realDeleteForImap
           useDnInMailBody
           useShortSubjectLine
           maxMessageLengthMinutes
           maxMailboxLengthMinutes
           doesMessageAge
           holdPeriodDays
           mailServerNetAddress
           mailServerProtocol
           defaultDeliveryFromAddress
           defaultNotificationFromAddress
           useOutgoingMWIOnSMDI
           mwiDelayInSeconds
           voicePortalScope
           enterpriseVoicePortalLicensed
           networkWideMessaging
           useExternalRouting
           defaultExternalRoutingAddress
           vmOnlySystem
           clientInitiatedMailServerSessionTimeoutMinutes
           recordingAudioFileFormat
           allowVoicePortalAccessFromVMDepositMenu
           allowVoicePortalAutoLoginForMobileDevicesOnly
           selectMwiTemplatePerCaller

    Attributes:

        real_delete_for_imap (Optional[bool]):

        use_dn_in_mail_body (Optional[bool]):

        use_short_subject_line (Optional[bool]):

        max_message_length_minutes (Optional[int]):

        max_mailbox_length_minutes (Optional[int]):

        does_message_age (Optional[bool]):

        hold_period_days (Optional[int]):

        mail_server_net_address (Optional[Nillable[str]]):

        mail_server_protocol (Optional[str]):

        default_delivery_from_address (Optional[str]):

        default_notification_from_address (Optional[str]):

        default_voice_portal_lockout_from_address (Optional[str]):

        use_outgoing_mwi_on_smdi (Optional[bool]):

        mwi_delay_in_seconds (Optional[int]):

        voice_portal_scope (Optional[str]):

        network_wide_messaging (Optional[bool]):

        use_external_routing (Optional[bool]):

        default_external_routing_address (Optional[Nillable[str]]):

        vm_only_system (Optional[bool]):

        client_initiated_mail_server_session_timeout_minutes (Optional[int]):

        recording_audio_file_format (Optional[str]):

        allow_voice_portal_access_from_vm_deposit_menu (Optional[bool]):

        allow_voice_portal_auto_login_for_mobile_devices_only (Optional[bool]):

        select_mwi_template_per_caller (Optional[bool]):

    """

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

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

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

    max_message_length_minutes: Optional[int] = field(
        default=None, metadata={"alias": "maxMessageLengthMinutes"}
    )

    max_mailbox_length_minutes: Optional[int] = field(
        default=None, metadata={"alias": "maxMailboxLengthMinutes"}
    )

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

    hold_period_days: Optional[int] = field(
        default=None, metadata={"alias": "holdPeriodDays"}
    )

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

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

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

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

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

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

    mwi_delay_in_seconds: Optional[int] = field(
        default=None, metadata={"alias": "mwiDelayInSeconds"}
    )

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

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

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

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

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

    client_initiated_mail_server_session_timeout_minutes: Optional[int] = field(
        default=None,
        metadata={"alias": "clientInitiatedMailServerSessionTimeoutMinutes"},
    )

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "mail_server_net_address",
            "default_external_routing_address",
        ]
        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 SystemVoiceMessagingGroupModifyRequestRI

client = Client()

command = SystemVoiceMessagingGroupModifyRequestRI(
    real_delete_for_imap=...,
    use_dn_in_mail_body=...,
    use_short_subject_line=...,
    max_message_length_minutes=...,
    max_mailbox_length_minutes=...,
    does_message_age=...,
    hold_period_days=...,
    mail_server_net_address=...,
    mail_server_protocol=...,
    default_delivery_from_address=...,
    default_notification_from_address=...,
    default_voice_portal_lockout_from_address=...,
    use_outgoing_mwi_on_smdi=...,
    mwi_delay_in_seconds=...,
    voice_portal_scope=...,
    network_wide_messaging=...,
    use_external_routing=...,
    default_external_routing_address=...,
    vm_only_system=...,
    client_initiated_mail_server_session_timeout_minutes=...,
    recording_audio_file_format=...,
    allow_voice_portal_access_from_vm_deposit_menu=...,
    allow_voice_portal_auto_login_for_mobile_devices_only=...,
    select_mwi_template_per_caller=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemVoiceMessagingGroupModifyRequestRI",
    real_delete_for_imap=...,
    use_dn_in_mail_body=...,
    use_short_subject_line=...,
    max_message_length_minutes=...,
    max_mailbox_length_minutes=...,
    does_message_age=...,
    hold_period_days=...,
    mail_server_net_address=...,
    mail_server_protocol=...,
    default_delivery_from_address=...,
    default_notification_from_address=...,
    default_voice_portal_lockout_from_address=...,
    use_outgoing_mwi_on_smdi=...,
    mwi_delay_in_seconds=...,
    voice_portal_scope=...,
    network_wide_messaging=...,
    use_external_routing=...,
    default_external_routing_address=...,
    vm_only_system=...,
    client_initiated_mail_server_session_timeout_minutes=...,
    recording_audio_file_format=...,
    allow_voice_portal_access_from_vm_deposit_menu=...,
    allow_voice_portal_auto_login_for_mobile_devices_only=...,
    select_mwi_template_per_caller=...,
)

print(response)