Skip to content

GroupHuntGroupGetInstanceRequest20

Bases: OCIRequest

Request to get all the information of a Hunt Group instance. The response is either GroupHuntGroupGetInstanceResponse20 or ErrorResponse.

Attributes:

service_user_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupHuntGroupGetInstanceRequest20(OCIRequest):
    """Request to get all the information of a Hunt Group instance.
        The response is either GroupHuntGroupGetInstanceResponse20 or ErrorResponse.

    Attributes:

        service_user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to GroupHuntGroupGetInstanceRequest20. Contains the service profile information and a table of assigned users. The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Weight", "Phone Number", "Extension", "Department", "Email Address", "Is Phone Number Activated", "Country Code","National Prefix", "Department Name" ,"Department Type", "Parent Department", "Parent Department Type","Group Id","Group Name". The following elements are only used in AS data mode: useSystemHuntGroupCLIDSetting includeHuntGroupNameInCLID Is Phone Number Activated Country Code National Prefix Department Name Department Type Parent Department Parent Department Type Group Id Group Name

Attributes:

service_instance_profile (ServiceInstanceReadProfile19sp1):

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_table (OCITable):

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 GroupHuntGroupGetInstanceResponse20(OCIDataResponse):
    """Response to GroupHuntGroupGetInstanceRequest20.
        Contains the service profile information and a table of assigned users.
        The table has column headings: \"User Id\", \"Last Name\", \"First Name\",
        \"Hiragana Last Name\", \"Hiragana First Name\", \"Weight\", \"Phone Number\",
        \"Extension\", \"Department\", \"Email Address\", \"Is Phone Number Activated\",
        \"Country Code\",\"National Prefix\", \"Department Name\" ,\"Department Type\",
        \"Parent Department\", \"Parent Department Type\",\"Group Id\",\"Group Name\".
        The following elements are only used in AS data mode:
           useSystemHuntGroupCLIDSetting
           includeHuntGroupNameInCLID
           Is Phone Number Activated
           Country Code
           National Prefix
           Department Name
           Department Type
           Parent Department
           Parent Department Type
           Group Id
           Group Name

    Attributes:

        service_instance_profile (ServiceInstanceReadProfile19sp1):

        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_table (OCITable):

        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_instance_profile: ServiceInstanceReadProfile19sp1 = 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_table: OCITable = field(metadata={"alias": "agentUserTable"})

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

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 GroupHuntGroupGetInstanceRequest20

client = Client()

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

print(response)