Skip to content

GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest20

Bases: OCIRequest

Modify the group's voice portal branding settings. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

voice_portal_greeting_selection (Optional[str]):

voice_portal_greeting_file (Optional[Nillable[AnnouncementFileKey]]):

voice_messaging_greeting_selection (Optional[str]):

voice_messaging_greeting_file (Optional[Nillable[AnnouncementFileKey]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest20(OCIRequest):
    """Modify the group's voice portal branding settings.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        voice_portal_greeting_selection (Optional[str]):

        voice_portal_greeting_file (Optional[Nillable[AnnouncementFileKey]]):

        voice_messaging_greeting_selection (Optional[str]):

        voice_messaging_greeting_file (Optional[Nillable[AnnouncementFileKey]]):

    """

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

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

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

    voice_portal_greeting_file: Optional[Nillable[AnnouncementFileKey]] = field(
        default=None, metadata={"alias": "voicePortalGreetingFile"}
    )

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

    voice_messaging_greeting_file: Optional[Nillable[AnnouncementFileKey]] = field(
        default=None, metadata={"alias": "voiceMessagingGreetingFile"}
    )

    def __post_init__(self):
        nillable_fields = [
            "voice_portal_greeting_file",
            "voice_messaging_greeting_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_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest20

client = Client()

command = GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest20(
    service_provider_id=...,
    group_id=...,
    voice_portal_greeting_selection=...,
    voice_portal_greeting_file=...,
    voice_messaging_greeting_selection=...,
    voice_messaging_greeting_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest20",
    service_provider_id=...,
    group_id=...,
    voice_portal_greeting_selection=...,
    voice_portal_greeting_file=...,
    voice_messaging_greeting_selection=...,
    voice_messaging_greeting_file=...,
)

print(response)