Skip to content

SystemSystemVoicePortalModifyRequest

Bases: OCIRequest

Request to update a System Voice portal instance. The response is either SuccessResponse or ErrorResponse.

The following elements are only used in AS data mode and ignored in XS data mode:
    networkClassOfService

Attributes:

system_voice_portal_id (str):

new_system_voice_portal_id (Optional[str]):

name (Optional[str]):

calling_line_id_name (Optional[str]):

language (Optional[str]):

time_zone (Optional[str]):

phone_number (Optional[Nillable[str]]):

public_user_identity (Optional[Nillable[str]]):

network_voice_portal_number (Optional[Nillable[str]]):

allow_identification_by_phone_number_or_voice_mail_aliases_on_login (Optional[bool]):

use_voice_portal_wizard (Optional[bool]):

become_default_system_voice_portal (Optional[bool]):

use_voice_portal_default_greeting (Optional[bool]):

voice_portal_greeting_file (Optional[LabeledMediaFileResource]):

use_voice_messaging_default_greeting (Optional[bool]):

voice_messaging_greeting_file (Optional[LabeledMediaFileResource]):

express_mode (Optional[bool]):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemSystemVoicePortalModifyRequest(OCIRequest):
    """Request to update a System  Voice portal instance.
        The response is either SuccessResponse or ErrorResponse.

        The following elements are only used in AS data mode and ignored in XS data mode:
            networkClassOfService

    Attributes:

        system_voice_portal_id (str):

        new_system_voice_portal_id (Optional[str]):

        name (Optional[str]):

        calling_line_id_name (Optional[str]):

        language (Optional[str]):

        time_zone (Optional[str]):

        phone_number (Optional[Nillable[str]]):

        public_user_identity (Optional[Nillable[str]]):

        network_voice_portal_number (Optional[Nillable[str]]):

        allow_identification_by_phone_number_or_voice_mail_aliases_on_login (Optional[bool]):

        use_voice_portal_wizard (Optional[bool]):

        become_default_system_voice_portal (Optional[bool]):

        use_voice_portal_default_greeting (Optional[bool]):

        voice_portal_greeting_file (Optional[LabeledMediaFileResource]):

        use_voice_messaging_default_greeting (Optional[bool]):

        voice_messaging_greeting_file (Optional[LabeledMediaFileResource]):

        express_mode (Optional[bool]):

        network_class_of_service (Optional[str]):

    """

    system_voice_portal_id: str = field(metadata={"alias": "systemVoicePortalId"})

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "phone_number",
            "public_user_identity",
            "network_voice_portal_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_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 SystemSystemVoicePortalModifyRequest

client = Client()

command = SystemSystemVoicePortalModifyRequest(
    system_voice_portal_id=...,
    new_system_voice_portal_id=...,
    name=...,
    calling_line_id_name=...,
    language=...,
    time_zone=...,
    phone_number=...,
    public_user_identity=...,
    network_voice_portal_number=...,
    allow_identification_by_phone_number_or_voice_mail_aliases_on_login=...,
    use_voice_portal_wizard=...,
    become_default_system_voice_portal=...,
    use_voice_portal_default_greeting=...,
    voice_portal_greeting_file=...,
    use_voice_messaging_default_greeting=...,
    voice_messaging_greeting_file=...,
    express_mode=...,
    network_class_of_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemSystemVoicePortalModifyRequest",
    system_voice_portal_id=...,
    new_system_voice_portal_id=...,
    name=...,
    calling_line_id_name=...,
    language=...,
    time_zone=...,
    phone_number=...,
    public_user_identity=...,
    network_voice_portal_number=...,
    allow_identification_by_phone_number_or_voice_mail_aliases_on_login=...,
    use_voice_portal_wizard=...,
    become_default_system_voice_portal=...,
    use_voice_portal_default_greeting=...,
    voice_portal_greeting_file=...,
    use_voice_messaging_default_greeting=...,
    voice_messaging_greeting_file=...,
    express_mode=...,
    network_class_of_service=...,
)

print(response)