Skip to content

GroupAutoAttendantConsolidatedAddInstanceRequest

Bases: OCIRequest

Add a Auto Attendant instance to a group and assign services to the Auto Attendant. The domain is required in the serviceUserId. Only Group and Enterprise level schedules are accepted. The response is either SuccessResponse or ErrorResponse.

If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true,
it will be added to group if the command is executed by a service provider administrator or above
and the number is already assigned to the service provider. The command will fail otherwise.

The following elements are only used in AS data mode:
  type, use AutoAttendantType.BASIC in XS mode.
  holidayMenu.
The following elements are only valid for Standard Auto
Attendants:
  holidayMenu

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

add_phone_number_to_group (Optional[bool]):

service_instance_profile (ServiceInstanceAddProfile):

type (str):

first_digit_timeout_seconds (int):

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 (Optional[AutoAttendantAddMenu20]):

after_hours_menu (Optional[AutoAttendantAddMenu20]):

holiday_menu (Optional[AutoAttendantAddMenu20]):

network_class_of_service (Optional[str]):

service (Optional[List[ConsolidatedUserServiceAssignment]]):

is_active (bool):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantConsolidatedAddInstanceRequest(OCIRequest):
    """Add a Auto Attendant instance to a group and assign services to the Auto Attendant.
        The domain is required in the serviceUserId.
        Only Group and Enterprise level schedules are accepted.
        The response is either SuccessResponse or ErrorResponse.

        If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true,
        it will be added to group if the command is executed by a service provider administrator or above
        and the number is already assigned to the service provider. The command will fail otherwise.

        The following elements are only used in AS data mode:
          type, use AutoAttendantType.BASIC in XS mode.
          holidayMenu.
        The following elements are only valid for Standard Auto
        Attendants:
          holidayMenu

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        add_phone_number_to_group (Optional[bool]):

        service_instance_profile (ServiceInstanceAddProfile):

        type (str):

        first_digit_timeout_seconds (int):

        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 (Optional[AutoAttendantAddMenu20]):

        after_hours_menu (Optional[AutoAttendantAddMenu20]):

        holiday_menu (Optional[AutoAttendantAddMenu20]):

        network_class_of_service (Optional[str]):

        service (Optional[List[ConsolidatedUserServiceAssignment]]):

        is_active (bool):

    """

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

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

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

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

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

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

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

    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: Optional[AutoAttendantAddMenu20] = field(
        default=None, metadata={"alias": "businessHoursMenu"}
    )

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

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

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

    service: Optional[List[ConsolidatedUserServiceAssignment]] = field(
        default=None, metadata={"alias": "service"}
    )

    is_active: bool = field(metadata={"alias": "isActive"})

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 GroupAutoAttendantConsolidatedAddInstanceRequest

client = Client()

command = GroupAutoAttendantConsolidatedAddInstanceRequest(
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    add_phone_number_to_group=...,
    service_instance_profile=...,
    type=...,
    first_digit_timeout_seconds=...,
    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=...,
    service=...,
    is_active=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAutoAttendantConsolidatedAddInstanceRequest",
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    add_phone_number_to_group=...,
    service_instance_profile=...,
    type=...,
    first_digit_timeout_seconds=...,
    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=...,
    service=...,
    is_active=...,
)

print(response)