Skip to content

SystemSystemVoicePortalAddRequest21sp1

Bases: OCIRequest

Request to add a system voice portal instance. The response is either SuccessResponse or ErrorResponse.

The following elements are only used in IMS mode:
publicUserIdentity, ignored in standalone mode if provided.

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

Attributes:

system_voice_portal_id (str):

name (str):

calling_line_id_name (str):

language (str):

time_zone (str):

phone_number (Optional[str]):

public_user_identity (Optional[str]):

network_voice_portal_number (Optional[str]):

allow_identification_by_phone_number_or_voice_mail_aliases_on_login (bool):

use_voice_portal_wizard (bool):

use_voice_portal_default_greeting (bool):

voice_portal_greeting_file (Optional[LabeledMediaFileResource]):

use_voice_messaging_default_greeting (bool):

voice_messaging_greeting_file (Optional[LabeledMediaFileResource]):

express_mode (bool):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemSystemVoicePortalAddRequest21sp1(OCIRequest):
    """Request to add a system voice portal instance.
        The response is either SuccessResponse or ErrorResponse.

        The following elements are only used in IMS mode:
        publicUserIdentity, ignored in standalone mode if provided.

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

    Attributes:

        system_voice_portal_id (str):

        name (str):

        calling_line_id_name (str):

        language (str):

        time_zone (str):

        phone_number (Optional[str]):

        public_user_identity (Optional[str]):

        network_voice_portal_number (Optional[str]):

        allow_identification_by_phone_number_or_voice_mail_aliases_on_login (bool):

        use_voice_portal_wizard (bool):

        use_voice_portal_default_greeting (bool):

        voice_portal_greeting_file (Optional[LabeledMediaFileResource]):

        use_voice_messaging_default_greeting (bool):

        voice_messaging_greeting_file (Optional[LabeledMediaFileResource]):

        express_mode (bool):

        network_class_of_service (Optional[str]):

    """

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

    name: str = field(metadata={"alias": "name"})

    calling_line_id_name: str = field(metadata={"alias": "callingLineIdName"})

    language: str = field(metadata={"alias": "language"})

    time_zone: str = field(metadata={"alias": "timeZone"})

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

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

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

    allow_identification_by_phone_number_or_voice_mail_aliases_on_login: bool = field(
        metadata={"alias": "allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin"}
    )

    use_voice_portal_wizard: bool = field(metadata={"alias": "useVoicePortalWizard"})

    use_voice_portal_default_greeting: bool = field(
        metadata={"alias": "useVoicePortalDefaultGreeting"}
    )

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

    use_voice_messaging_default_greeting: bool = field(
        metadata={"alias": "useVoiceMessagingDefaultGreeting"}
    )

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

    express_mode: bool = field(metadata={"alias": "expressMode"})

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

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 SystemSystemVoicePortalAddRequest21sp1

client = Client()

command = SystemSystemVoicePortalAddRequest21sp1(
    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=...,
    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.client import Client

client = Client()

response = client.raw_command("SystemSystemVoicePortalAddRequest21sp1",
    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=...,
    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)