Skip to content

UserVoiceMessagingUserModifyGreetingRequest20

Bases: OCIRequest

Modify the user's voice messaging greeting. The response is either a SuccessResponse or an ErrorResponse. Engineering Note: This command is used internally by Call Processing. The following elements are only used in AS data mode: disableMessageDeposit disableMessageDepositAction greetingOnlyForwardDestination

Attributes:

user_id (str):

busy_announcement_selection (Optional[str]):

busy_personal_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

busy_personal_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

no_answer_announcement_selection (Optional[str]):

no_answer_personal_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

no_answer_personal_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

no_answer_alternate_greeting01 (Optional[VoiceMessagingAlternateNoAnswerGreetingModify20]):

no_answer_alternate_greeting02 (Optional[VoiceMessagingAlternateNoAnswerGreetingModify20]):

no_answer_alternate_greeting03 (Optional[VoiceMessagingAlternateNoAnswerGreetingModify20]):

extended_away_enabled (Optional[bool]):

extended_away_disable_message_deposit (Optional[bool]):

extended_away_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

extended_away_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

no_answer_number_of_rings (Optional[int]):

disable_message_deposit (Optional[bool]):

disable_message_deposit_action (Optional[str]):

greeting_only_forward_destination (Optional[Nillable[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserVoiceMessagingUserModifyGreetingRequest20(OCIRequest):
    """Modify the user's voice messaging greeting.
        The response is either a SuccessResponse or an ErrorResponse.
        Engineering Note: This command is used internally by Call Processing.
        The following elements are only used in AS data mode:
          disableMessageDeposit
          disableMessageDepositAction
          greetingOnlyForwardDestination

    Attributes:

        user_id (str):

        busy_announcement_selection (Optional[str]):

        busy_personal_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        busy_personal_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        no_answer_announcement_selection (Optional[str]):

        no_answer_personal_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        no_answer_personal_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        no_answer_alternate_greeting01 (Optional[VoiceMessagingAlternateNoAnswerGreetingModify20]):

        no_answer_alternate_greeting02 (Optional[VoiceMessagingAlternateNoAnswerGreetingModify20]):

        no_answer_alternate_greeting03 (Optional[VoiceMessagingAlternateNoAnswerGreetingModify20]):

        extended_away_enabled (Optional[bool]):

        extended_away_disable_message_deposit (Optional[bool]):

        extended_away_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        extended_away_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        no_answer_number_of_rings (Optional[int]):

        disable_message_deposit (Optional[bool]):

        disable_message_deposit_action (Optional[str]):

        greeting_only_forward_destination (Optional[Nillable[str]]):

    """

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

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

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

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

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

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

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

    no_answer_alternate_greeting01: Optional[
        VoiceMessagingAlternateNoAnswerGreetingModify20
    ] = field(default=None, metadata={"alias": "noAnswerAlternateGreeting01"})

    no_answer_alternate_greeting02: Optional[
        VoiceMessagingAlternateNoAnswerGreetingModify20
    ] = field(default=None, metadata={"alias": "noAnswerAlternateGreeting02"})

    no_answer_alternate_greeting03: Optional[
        VoiceMessagingAlternateNoAnswerGreetingModify20
    ] = field(default=None, metadata={"alias": "noAnswerAlternateGreeting03"})

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

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

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

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

    no_answer_number_of_rings: Optional[int] = field(
        default=None, metadata={"alias": "noAnswerNumberOfRings"}
    )

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "busy_personal_audio_file",
            "busy_personal_video_file",
            "no_answer_personal_audio_file",
            "no_answer_personal_video_file",
            "extended_away_audio_file",
            "extended_away_video_file",
            "greeting_only_forward_destination",
        ]
        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 UserVoiceMessagingUserModifyGreetingRequest20

client = Client()

command = UserVoiceMessagingUserModifyGreetingRequest20(
    user_id=...,
    busy_announcement_selection=...,
    busy_personal_audio_file=...,
    busy_personal_video_file=...,
    no_answer_announcement_selection=...,
    no_answer_personal_audio_file=...,
    no_answer_personal_video_file=...,
    no_answer_alternate_greeting01=...,
    no_answer_alternate_greeting02=...,
    no_answer_alternate_greeting03=...,
    extended_away_enabled=...,
    extended_away_disable_message_deposit=...,
    extended_away_audio_file=...,
    extended_away_video_file=...,
    no_answer_number_of_rings=...,
    disable_message_deposit=...,
    disable_message_deposit_action=...,
    greeting_only_forward_destination=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserVoiceMessagingUserModifyGreetingRequest20",
    user_id=...,
    busy_announcement_selection=...,
    busy_personal_audio_file=...,
    busy_personal_video_file=...,
    no_answer_announcement_selection=...,
    no_answer_personal_audio_file=...,
    no_answer_personal_video_file=...,
    no_answer_alternate_greeting01=...,
    no_answer_alternate_greeting02=...,
    no_answer_alternate_greeting03=...,
    extended_away_enabled=...,
    extended_away_disable_message_deposit=...,
    extended_away_audio_file=...,
    extended_away_video_file=...,
    no_answer_number_of_rings=...,
    disable_message_deposit=...,
    disable_message_deposit_action=...,
    greeting_only_forward_destination=...,
)

print(response)