UserVoiceMessagingUserModifyVoicePortalRequest20

Bases: OCIRequest

Modify the user's voice messaging voice portal settings. The response is either a SuccessResponse or an ErrorResponse. Engineering Note: This command is used internally by Call Processing.

Attributes:

user_id (str):

use_personalized_name (Optional[bool]):

voice_portal_auto_login (Optional[bool]):

personalized_name_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

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

@dataclass(kw_only=True)
class UserVoiceMessagingUserModifyVoicePortalRequest20(OCIRequest):
    """Modify the user's voice messaging voice portal settings.
        The response is either a SuccessResponse or an ErrorResponse.
        Engineering Note: This command is used internally by Call Processing.

    Attributes:

        user_id (str):

        use_personalized_name (Optional[bool]):

        voice_portal_auto_login (Optional[bool]):

        personalized_name_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

    """

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["personalized_name_audio_file"]
        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 UserVoiceMessagingUserModifyVoicePortalRequest20

client = Client()

command = UserVoiceMessagingUserModifyVoicePortalRequest20(
    user_id=...,
    use_personalized_name=...,
    voice_portal_auto_login=...,
    personalized_name_audio_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserVoiceMessagingUserModifyVoicePortalRequest20",
    user_id=...,
    use_personalized_name=...,
    voice_portal_auto_login=...,
    personalized_name_audio_file=...,
)

print(response)