Skip to content

SystemSystemVoicePortalGetRequest23

Bases: OCIRequest

Request to get a system voice portal instance. The response is either SystemSystemVoicePortalGetResponse23 or ErrorResponse.

Attributes:

system_voice_portal_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemSystemVoicePortalGetRequest23(OCIRequest):
    """Request to get a system voice portal instance.
        The response is either SystemSystemVoicePortalGetResponse23 or ErrorResponse.

    Attributes:

        system_voice_portal_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to SystemSystemVoicePortalGetRequest23.

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

Attributes:

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):

is_default (bool):

use_voice_portal_default_greeting (bool):

voice_portal_greeting_file_description (Optional[str]):

voice_portal_greeting_media_file_type (Optional[str]):

use_voice_messaging_default_greeting (bool):

voice_messaging_greeting_file_description (Optional[str]):

voice_messaging_greeting_media_file_type (Optional[str]):

express_mode (bool):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemSystemVoicePortalGetResponse23(OCIDataResponse):
    """Response to SystemSystemVoicePortalGetRequest23.

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

    Attributes:

        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):

        is_default (bool):

        use_voice_portal_default_greeting (bool):

        voice_portal_greeting_file_description (Optional[str]):

        voice_portal_greeting_media_file_type (Optional[str]):

        use_voice_messaging_default_greeting (bool):

        voice_messaging_greeting_file_description (Optional[str]):

        voice_messaging_greeting_media_file_type (Optional[str]):

        express_mode (bool):

        network_class_of_service (Optional[str]):

    """

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

    is_default: bool = field(metadata={"alias": "isDefault"})

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

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

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

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

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

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

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

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

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 SystemSystemVoicePortalGetRequest23

client = Client()

command = SystemSystemVoicePortalGetRequest23(
    system_voice_portal_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemSystemVoicePortalGetRequest23",
    system_voice_portal_id=...,
)

print(response)