Skip to content

GroupAutoAttendantGetInstanceRequest24

Bases: OCIRequest

Request to get all the information of an Auto Attendant instance. The response is either GroupAutoAttendantGetInstanceResponse24 or ErrorResponse.

Attributes:

service_user_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantGetInstanceRequest24(OCIRequest):
    """Request to get all the information of an Auto Attendant instance.
        The response is either GroupAutoAttendantGetInstanceResponse24 or ErrorResponse.

    Attributes:

        service_user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to GroupAutoAttendantGetInstanceRequest24. Contains the service profile information.

The following elements are only used in AS data mode and not returned in XS
datamode:
transferToOperatorAudioFile,
transferToOperatorVideoFile,
type (use AutoAttendantType.BASIC in XS mode),
holidayMenu.

The following element is only used in AS data mode:
transferToOperatorAnnouncementSelection, value "Default" is returned in XS data
mode.

The following elements are only valid for Standard Auto
Attendants:
  holidayMenu

Attributes:

service_instance_profile (ServiceInstanceReadProfile19sp1):

type (str):

first_digit_timeout_seconds (int):

transfer_to_operator_announcement_selection (str):

transfer_to_operator_audio_file (Optional[AnnouncementFileLevelKey]):

transfer_to_operator_video_file (Optional[AnnouncementFileLevelKey]):

enable_video (bool):

business_hours (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

extension_dialing_scope (str):

name_dialing_scope (str):

name_dialing_entries (str):

business_hours_menu (AutoAttendantReadMenu20):

after_hours_menu (AutoAttendantReadMenu20):

holiday_menu (Optional[AutoAttendantReadMenu20]):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantGetInstanceResponse24(OCIDataResponse):
    """Response to GroupAutoAttendantGetInstanceRequest24.
        Contains the service profile information.

        The following elements are only used in AS data mode and not returned in XS
        datamode:
        transferToOperatorAudioFile,
        transferToOperatorVideoFile,
        type (use AutoAttendantType.BASIC in XS mode),
        holidayMenu.

        The following element is only used in AS data mode:
        transferToOperatorAnnouncementSelection, value \"Default\" is returned in XS data
        mode.

        The following elements are only valid for Standard Auto
        Attendants:
          holidayMenu

    Attributes:

        service_instance_profile (ServiceInstanceReadProfile19sp1):

        type (str):

        first_digit_timeout_seconds (int):

        transfer_to_operator_announcement_selection (str):

        transfer_to_operator_audio_file (Optional[AnnouncementFileLevelKey]):

        transfer_to_operator_video_file (Optional[AnnouncementFileLevelKey]):

        enable_video (bool):

        business_hours (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

        extension_dialing_scope (str):

        name_dialing_scope (str):

        name_dialing_entries (str):

        business_hours_menu (AutoAttendantReadMenu20):

        after_hours_menu (AutoAttendantReadMenu20):

        holiday_menu (Optional[AutoAttendantReadMenu20]):

        network_class_of_service (Optional[str]):

    """

    service_instance_profile: ServiceInstanceReadProfile19sp1 = field(
        metadata={"alias": "serviceInstanceProfile"}
    )

    type: str = field(metadata={"alias": "type"})

    first_digit_timeout_seconds: int = field(
        metadata={"alias": "firstDigitTimeoutSeconds"}
    )

    transfer_to_operator_announcement_selection: str = field(
        metadata={"alias": "transferToOperatorAnnouncementSelection"}
    )

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

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

    enable_video: bool = field(metadata={"alias": "enableVideo"})

    business_hours: Optional[TimeSchedule] = field(
        default=None, metadata={"alias": "businessHours"}
    )

    holiday_schedule: Optional[HolidaySchedule] = field(
        default=None, metadata={"alias": "holidaySchedule"}
    )

    extension_dialing_scope: str = field(metadata={"alias": "extensionDialingScope"})

    name_dialing_scope: str = field(metadata={"alias": "nameDialingScope"})

    name_dialing_entries: str = field(metadata={"alias": "nameDialingEntries"})

    business_hours_menu: AutoAttendantReadMenu20 = field(
        metadata={"alias": "businessHoursMenu"}
    )

    after_hours_menu: AutoAttendantReadMenu20 = field(
        metadata={"alias": "afterHoursMenu"}
    )

    holiday_menu: Optional[AutoAttendantReadMenu20] = field(
        default=None, metadata={"alias": "holidayMenu"}
    )

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

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 GroupAutoAttendantGetInstanceRequest24

client = Client()

command = GroupAutoAttendantGetInstanceRequest24(
    service_user_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("GroupAutoAttendantGetInstanceRequest24",
    service_user_id=...,
)

print(response)