Skip to content

GroupVoiceMessagingGroupGetRequest

Bases: OCIRequest

Requests the group's Voice Messaging settings. The response is either GroupVoiceMessagingGroupGetResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupVoiceMessagingGroupGetRequest(OCIRequest):
    """Requests the group's Voice Messaging settings.
        The response is either GroupVoiceMessagingGroupGetResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

Responses

Bases: OCIDataResponse

Response to GroupVoiceMessagingGroupGetRequest. Contains the group's voice messaging settings.

Attributes:

use_mail_server_setting (str):

warn_caller_before_recording_voice_message (bool):

allow_users_configuring_advanced_settings (bool):

allow_compose_or_forward_message_to_entire_group (bool):

mail_server_net_address (Optional[str]):

mail_server_protocol (str):

real_delete_for_imap (bool):

max_mailbox_length_minutes (int):

does_message_age (bool):

hold_period_days (int):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupVoiceMessagingGroupGetResponse(OCIDataResponse):
    """Response to GroupVoiceMessagingGroupGetRequest.
        Contains the group's voice messaging settings.

    Attributes:

        use_mail_server_setting (str):

        warn_caller_before_recording_voice_message (bool):

        allow_users_configuring_advanced_settings (bool):

        allow_compose_or_forward_message_to_entire_group (bool):

        mail_server_net_address (Optional[str]):

        mail_server_protocol (str):

        real_delete_for_imap (bool):

        max_mailbox_length_minutes (int):

        does_message_age (bool):

        hold_period_days (int):

    """

    use_mail_server_setting: str = field(metadata={"alias": "useMailServerSetting"})

    warn_caller_before_recording_voice_message: bool = field(
        metadata={"alias": "warnCallerBeforeRecordingVoiceMessage"}
    )

    allow_users_configuring_advanced_settings: bool = field(
        metadata={"alias": "allowUsersConfiguringAdvancedSettings"}
    )

    allow_compose_or_forward_message_to_entire_group: bool = field(
        metadata={"alias": "allowComposeOrForwardMessageToEntireGroup"}
    )

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

    mail_server_protocol: str = field(metadata={"alias": "mailServerProtocol"})

    real_delete_for_imap: bool = field(metadata={"alias": "realDeleteForImap"})

    max_mailbox_length_minutes: int = field(
        metadata={"alias": "maxMailboxLengthMinutes"}
    )

    does_message_age: bool = field(metadata={"alias": "doesMessageAge"})

    hold_period_days: int = field(metadata={"alias": "holdPeriodDays"})

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 GroupVoiceMessagingGroupGetRequest

client = Client()

command = GroupVoiceMessagingGroupGetRequest(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupVoiceMessagingGroupGetRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)