Skip to content

GroupAutoAttendantSubmenuGetRequest20

Bases: OCIRequest

Request to get an Auto Attendant submenu instance. The response is either GroupAutoAttendantSubmenuGetResponse20 or ErrorResponse. This request is only valid for Standard auto attendants.

Attributes:

service_user_id (str):

submenu_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantSubmenuGetRequest20(OCIRequest):
    """Request to get an Auto Attendant submenu instance.
        The response is either GroupAutoAttendantSubmenuGetResponse20 or ErrorResponse.
        This request is only valid for Standard auto attendants.

    Attributes:

        service_user_id (str):

        submenu_id (str):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    submenu_id: str = field(metadata={"alias": "submenuId"})

Responses

Bases: OCIDataResponse

Response to GroupAutoAttendantSubmenuGetRequest20. Contains AutoAttendant submenu information.

Attributes:

announcement_selection (str):

audio_file (Optional[AnnouncementFileLevelKey]):

video_file (Optional[AnnouncementFileLevelKey]):

enable_level_extension_dialing (bool):

key_configuration (Optional[List[AutoAttendantKeyReadConfiguration20]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantSubmenuGetResponse20(OCIDataResponse):
    """Response to GroupAutoAttendantSubmenuGetRequest20.
        Contains AutoAttendant submenu information.

    Attributes:

        announcement_selection (str):

        audio_file (Optional[AnnouncementFileLevelKey]):

        video_file (Optional[AnnouncementFileLevelKey]):

        enable_level_extension_dialing (bool):

        key_configuration (Optional[List[AutoAttendantKeyReadConfiguration20]]):

    """

    announcement_selection: str = field(metadata={"alias": "announcementSelection"})

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

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

    enable_level_extension_dialing: bool = field(
        metadata={"alias": "enableLevelExtensionDialing"}
    )

    key_configuration: Optional[List[AutoAttendantKeyReadConfiguration20]] = field(
        default=None, metadata={"alias": "keyConfiguration"}
    )

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 GroupAutoAttendantSubmenuGetRequest20

client = Client()

command = GroupAutoAttendantSubmenuGetRequest20(
    service_user_id=...,
    submenu_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("GroupAutoAttendantSubmenuGetRequest20",
    service_user_id=...,
    submenu_id=...,
)

print(response)