UserVoiceMessagingUserGetVoicePortalRequest20

Bases: OCIRequest

Get the user's voice messaging voice portal settings. The response is either a UserVoiceMessagingUserGetVoicePortalResponse20 or an ErrorResponse.

Attributes:

user_id (str):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class UserVoiceMessagingUserGetVoicePortalRequest20(OCIRequest):
    """Get the user's voice messaging voice portal settings.
        The response is either a UserVoiceMessagingUserGetVoicePortalResponse20 or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserVoiceMessagingUserGetVoicePortalRequest20.

Attributes:

use_personalized_name (bool):

voice_portal_auto_login (bool):

personalized_name_audio_file (Optional[AnnouncementFileLevelKey]):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class UserVoiceMessagingUserGetVoicePortalResponse20(OCIDataResponse):
    """Response to UserVoiceMessagingUserGetVoicePortalRequest20.

    Attributes:

        use_personalized_name (bool):

        voice_portal_auto_login (bool):

        personalized_name_audio_file (Optional[AnnouncementFileLevelKey]):

    """

    use_personalized_name: bool = field(metadata={"alias": "usePersonalizedName"})

    voice_portal_auto_login: bool = field(metadata={"alias": "voicePortalAutoLogin"})

    personalized_name_audio_file: Optional[AnnouncementFileLevelKey] = field(
        default=None, metadata={"alias": "personalizedNameAudioFile"}
    )

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 UserVoiceMessagingUserGetVoicePortalRequest20

client = Client()

command = UserVoiceMessagingUserGetVoicePortalRequest20(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserVoiceMessagingUserGetVoicePortalRequest20",
    user_id=...,
)

print(response)