Skip to content

GroupHuntGroupAddInstanceRequest20

Bases: OCIRequest

Add a Hunt Group instance to a group. The domain is required in the serviceUserId. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value "true" in XS data mode includeHuntGroupNameInCLID, use value "true" in XS data mode

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

service_instance_profile (ServiceInstanceAddProfile):

policy (str):

hunt_after_no_answer (bool):

no_answer_number_of_rings (int):

forward_after_timeout (bool):

forward_timeout_seconds (int):

forward_to_phone_number (Optional[str]):

agent_user_id (Optional[List[str]]):

allow_call_waiting_for_agents (bool):

use_system_hunt_group_clid_setting (bool):

include_hunt_group_name_in_clid (bool):

enable_not_reachable_forwarding (bool):

not_reachable_forward_to_phone_number (Optional[str]):

make_busy_when_not_reachable (bool):

allow_members_to_control_group_busy (bool):

enable_group_busy (bool):

apply_group_busy_when_terminating_to_agent (bool):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupHuntGroupAddInstanceRequest20(OCIRequest):
    """Add a Hunt Group instance to a group.
        The domain is required in the serviceUserId.
        The response is either SuccessResponse or ErrorResponse.
        The following elements are only used in AS data mode:
           useSystemHuntGroupCLIDSetting, use value \"true\" in XS data mode
           includeHuntGroupNameInCLID, use value \"true\" in XS data mode

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        service_instance_profile (ServiceInstanceAddProfile):

        policy (str):

        hunt_after_no_answer (bool):

        no_answer_number_of_rings (int):

        forward_after_timeout (bool):

        forward_timeout_seconds (int):

        forward_to_phone_number (Optional[str]):

        agent_user_id (Optional[List[str]]):

        allow_call_waiting_for_agents (bool):

        use_system_hunt_group_clid_setting (bool):

        include_hunt_group_name_in_clid (bool):

        enable_not_reachable_forwarding (bool):

        not_reachable_forward_to_phone_number (Optional[str]):

        make_busy_when_not_reachable (bool):

        allow_members_to_control_group_busy (bool):

        enable_group_busy (bool):

        apply_group_busy_when_terminating_to_agent (bool):

        network_class_of_service (Optional[str]):

    """

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

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

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

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

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

    hunt_after_no_answer: bool = field(metadata={"alias": "huntAfterNoAnswer"})

    no_answer_number_of_rings: int = field(metadata={"alias": "noAnswerNumberOfRings"})

    forward_after_timeout: bool = field(metadata={"alias": "forwardAfterTimeout"})

    forward_timeout_seconds: int = field(metadata={"alias": "forwardTimeoutSeconds"})

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

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

    allow_call_waiting_for_agents: bool = field(
        metadata={"alias": "allowCallWaitingForAgents"}
    )

    use_system_hunt_group_clid_setting: bool = field(
        metadata={"alias": "useSystemHuntGroupCLIDSetting"}
    )

    include_hunt_group_name_in_clid: bool = field(
        metadata={"alias": "includeHuntGroupNameInCLID"}
    )

    enable_not_reachable_forwarding: bool = field(
        metadata={"alias": "enableNotReachableForwarding"}
    )

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

    make_busy_when_not_reachable: bool = field(
        metadata={"alias": "makeBusyWhenNotReachable"}
    )

    allow_members_to_control_group_busy: bool = field(
        metadata={"alias": "allowMembersToControlGroupBusy"}
    )

    enable_group_busy: bool = field(metadata={"alias": "enableGroupBusy"})

    apply_group_busy_when_terminating_to_agent: bool = field(
        metadata={"alias": "applyGroupBusyWhenTerminatingToAgent"}
    )

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

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 GroupHuntGroupAddInstanceRequest20

client = Client()

command = GroupHuntGroupAddInstanceRequest20(
    service_provider_id=...,
    group_id=...,
    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=...,
    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("GroupHuntGroupAddInstanceRequest20",
    service_provider_id=...,
    group_id=...,
    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=...,
    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)