Skip to content

GroupAutoAttendantModifyInstanceRequest20

Bases: OCIRequest

Request to modify an Auto Attendant instance. Only Group and Enterprise level schedules are accepted. The response is either SuccessResponse or ErrorResponse.

The following elements are only used in AS data mode and not returned in XS
datamode:
 transferToOperatorAudioFile,
 transferToOperatorVideoFile,
 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_user_id (str):

service_instance_profile (Optional[ServiceInstanceModifyProfile]):

first_digit_timeout_seconds (Optional[int]):

transfer_to_operator_announcement_selection (Optional[str]):

transfer_to_operator_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

transfer_to_operator_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

enable_video (Optional[bool]):

business_hours (Optional[Nillable[TimeSchedule]]):

holiday_schedule (Optional[Nillable[HolidaySchedule]]):

extension_dialing_scope (Optional[str]):

name_dialing_scope (Optional[str]):

name_dialing_entries (Optional[str]):

business_hours_menu (Optional[AutoAttendantModifyMenu20]):

after_hours_menu (Optional[AutoAttendantModifyMenu20]):

holiday_menu (Optional[AutoAttendantModifyMenu20]):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantModifyInstanceRequest20(OCIRequest):
    """Request to modify an Auto Attendant instance.
        Only Group and Enterprise level schedules are accepted.
        The response is either SuccessResponse or ErrorResponse.

        The following elements are only used in AS data mode and not returned in XS
        datamode:
         transferToOperatorAudioFile,
         transferToOperatorVideoFile,
         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_user_id (str):

        service_instance_profile (Optional[ServiceInstanceModifyProfile]):

        first_digit_timeout_seconds (Optional[int]):

        transfer_to_operator_announcement_selection (Optional[str]):

        transfer_to_operator_audio_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        transfer_to_operator_video_file (Optional[Nillable[AnnouncementFileLevelKey]]):

        enable_video (Optional[bool]):

        business_hours (Optional[Nillable[TimeSchedule]]):

        holiday_schedule (Optional[Nillable[HolidaySchedule]]):

        extension_dialing_scope (Optional[str]):

        name_dialing_scope (Optional[str]):

        name_dialing_entries (Optional[str]):

        business_hours_menu (Optional[AutoAttendantModifyMenu20]):

        after_hours_menu (Optional[AutoAttendantModifyMenu20]):

        holiday_menu (Optional[AutoAttendantModifyMenu20]):

        network_class_of_service (Optional[str]):

    """

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

    service_instance_profile: Optional[ServiceInstanceModifyProfile] = field(
        default=None, metadata={"alias": "serviceInstanceProfile"}
    )

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

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

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

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

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

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

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

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

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

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

    business_hours_menu: Optional[AutoAttendantModifyMenu20] = field(
        default=None, metadata={"alias": "businessHoursMenu"}
    )

    after_hours_menu: Optional[AutoAttendantModifyMenu20] = field(
        default=None, metadata={"alias": "afterHoursMenu"}
    )

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

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

    def __post_init__(self):
        nillable_fields = [
            "transfer_to_operator_audio_file",
            "transfer_to_operator_video_file",
            "business_hours",
            "holiday_schedule",
        ]
        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 GroupAutoAttendantModifyInstanceRequest20

client = Client()

command = GroupAutoAttendantModifyInstanceRequest20(
    service_user_id=...,
    service_instance_profile=...,
    first_digit_timeout_seconds=...,
    transfer_to_operator_announcement_selection=...,
    transfer_to_operator_audio_file=...,
    transfer_to_operator_video_file=...,
    enable_video=...,
    business_hours=...,
    holiday_schedule=...,
    extension_dialing_scope=...,
    name_dialing_scope=...,
    name_dialing_entries=...,
    business_hours_menu=...,
    after_hours_menu=...,
    holiday_menu=...,
    network_class_of_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAutoAttendantModifyInstanceRequest20",
    service_user_id=...,
    service_instance_profile=...,
    first_digit_timeout_seconds=...,
    transfer_to_operator_announcement_selection=...,
    transfer_to_operator_audio_file=...,
    transfer_to_operator_video_file=...,
    enable_video=...,
    business_hours=...,
    holiday_schedule=...,
    extension_dialing_scope=...,
    name_dialing_scope=...,
    name_dialing_entries=...,
    business_hours_menu=...,
    after_hours_menu=...,
    holiday_menu=...,
    network_class_of_service=...,
)

print(response)