Skip to content

GroupHuntGroupModifyInstanceRequest

Bases: OCIRequest

Request to modify a Hunt Group instance. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode: useSystemHuntGroupCLIDSetting includeHuntGroupNameInCLID applyGroupBusyWhenTerminatingToAgent networkClassOfService

Attributes:

service_user_id (str):

service_instance_profile (Optional[ServiceInstanceModifyProfile]):

policy (Optional[str]):

hunt_after_no_answer (Optional[bool]):

no_answer_number_of_rings (Optional[int]):

forward_after_timeout (Optional[bool]):

forward_timeout_seconds (Optional[int]):

forward_to_phone_number (Optional[Nillable[str]]):

agent_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

allow_call_waiting_for_agents (Optional[bool]):

use_system_hunt_group_clid_setting (Optional[bool]):

include_hunt_group_name_in_clid (Optional[bool]):

enable_not_reachable_forwarding (Optional[bool]):

not_reachable_forward_to_phone_number (Optional[Nillable[str]]):

make_busy_when_not_reachable (Optional[bool]):

allow_members_to_control_group_busy (Optional[bool]):

enable_group_busy (Optional[bool]):

apply_group_busy_when_terminating_to_agent (Optional[bool]):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupHuntGroupModifyInstanceRequest(OCIRequest):
    """Request to modify a Hunt Group instance.
        The response is either SuccessResponse or ErrorResponse.
        The following elements are only used in AS data mode:
           useSystemHuntGroupCLIDSetting
           includeHuntGroupNameInCLID
           applyGroupBusyWhenTerminatingToAgent
           networkClassOfService

    Attributes:

        service_user_id (str):

        service_instance_profile (Optional[ServiceInstanceModifyProfile]):

        policy (Optional[str]):

        hunt_after_no_answer (Optional[bool]):

        no_answer_number_of_rings (Optional[int]):

        forward_after_timeout (Optional[bool]):

        forward_timeout_seconds (Optional[int]):

        forward_to_phone_number (Optional[Nillable[str]]):

        agent_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

        allow_call_waiting_for_agents (Optional[bool]):

        use_system_hunt_group_clid_setting (Optional[bool]):

        include_hunt_group_name_in_clid (Optional[bool]):

        enable_not_reachable_forwarding (Optional[bool]):

        not_reachable_forward_to_phone_number (Optional[Nillable[str]]):

        make_busy_when_not_reachable (Optional[bool]):

        allow_members_to_control_group_busy (Optional[bool]):

        enable_group_busy (Optional[bool]):

        apply_group_busy_when_terminating_to_agent (Optional[bool]):

        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"}
    )

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

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

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

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

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

    forward_to_phone_number: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "forwardToPhoneNumber"}
    )

    agent_user_id_list: Optional[Nillable[ReplacementUserIdList]] = field(
        default=None, metadata={"alias": "agentUserIdList"}
    )

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

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

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

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

    not_reachable_forward_to_phone_number: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "notReachableForwardToPhoneNumber"}
    )

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "forward_to_phone_number",
            "agent_user_id_list",
            "not_reachable_forward_to_phone_number",
        ]
        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 GroupHuntGroupModifyInstanceRequest

client = Client()

command = GroupHuntGroupModifyInstanceRequest(
    service_user_id=...,
    service_instance_profile=...,
    policy=...,
    hunt_after_no_answer=...,
    no_answer_number_of_rings=...,
    forward_after_timeout=...,
    forward_timeout_seconds=...,
    forward_to_phone_number=...,
    agent_user_id_list=...,
    allow_call_waiting_for_agents=...,
    use_system_hunt_group_clid_setting=...,
    include_hunt_group_name_in_clid=...,
    enable_not_reachable_forwarding=...,
    not_reachable_forward_to_phone_number=...,
    make_busy_when_not_reachable=...,
    allow_members_to_control_group_busy=...,
    enable_group_busy=...,
    apply_group_busy_when_terminating_to_agent=...,
    network_class_of_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupHuntGroupModifyInstanceRequest",
    service_user_id=...,
    service_instance_profile=...,
    policy=...,
    hunt_after_no_answer=...,
    no_answer_number_of_rings=...,
    forward_after_timeout=...,
    forward_timeout_seconds=...,
    forward_to_phone_number=...,
    agent_user_id_list=...,
    allow_call_waiting_for_agents=...,
    use_system_hunt_group_clid_setting=...,
    include_hunt_group_name_in_clid=...,
    enable_not_reachable_forwarding=...,
    not_reachable_forward_to_phone_number=...,
    make_busy_when_not_reachable=...,
    allow_members_to_control_group_busy=...,
    enable_group_busy=...,
    apply_group_busy_when_terminating_to_agent=...,
    network_class_of_service=...,
)

print(response)