GroupHuntGroupConsolidatedModifyInstanceRequest
Bases: OCIRequest
Request to modify a Hunt Group instance.
When phone numbers are un-assigned from the user, the unused numbers may be un-assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above.
When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above.
When omitted, the number(s) will be left assigned to the group.
An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege.
If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if needed if the command is executed by a service provider administrator and above. The command will fail otherwise.
The response is either SuccessResponse or ErrorResponse.
The following elements are only used in AS data mode:
useSystemHuntGroupCLIDSetting
includeHuntGroupNameInCLID
Attributes:
service_user_id (str):
unassign_phone_numbers (Optional[str]):
add_phone_number_to_group (Optional[bool]):
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]]):
agent_weight_list (Optional[Nillable[ReplacementAgentWeightList]]):
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_list (Optional[Nillable[ReplacementConsolidatedUserServiceAssignmentList]]):
is_active (Optional[bool]):
directory_number_hunting_agent_user_id_list (Optional[Nillable[ReplacementUserIdList]]):
directory_number_hunting_use_terminate_call_to_agent_first (Optional[bool]):
directory_number_hunting_use_original_agent_services_for_busy_and_no_answer_calls (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
49619 49620 49621 49622 49623 49624 49625 49626 49627 49628 49629 49630 49631 49632 49633 49634 49635 49636 49637 49638 49639 49640 49641 49642 49643 49644 49645 49646 49647 49648 49649 49650 49651 49652 49653 49654 49655 49656 49657 49658 49659 49660 49661 49662 49663 49664 49665 49666 49667 49668 49669 49670 49671 49672 49673 49674 49675 49676 49677 49678 49679 49680 49681 49682 49683 49684 49685 49686 49687 49688 49689 49690 49691 49692 49693 49694 49695 49696 49697 49698 49699 49700 49701 49702 49703 49704 49705 49706 49707 49708 49709 49710 49711 49712 49713 49714 49715 49716 49717 49718 49719 49720 49721 49722 49723 49724 49725 49726 49727 49728 49729 49730 49731 49732 49733 49734 49735 49736 49737 49738 49739 49740 49741 49742 49743 49744 49745 49746 49747 49748 49749 49750 49751 49752 49753 49754 49755 49756 49757 49758 49759 49760 49761 49762 49763 49764 49765 49766 49767 49768 49769 49770 49771 49772 49773 49774 49775 49776 49777 49778 49779 49780 49781 49782 49783 49784 49785 49786 49787 49788 49789 49790 49791 49792 49793 49794 49795 49796 49797 49798 49799 49800 49801 49802 49803 49804 49805 49806 49807 49808 49809 49810 49811 49812 49813 | |
Responses
Example Usage
from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupHuntGroupConsolidatedModifyInstanceRequest
client = Client()
command = GroupHuntGroupConsolidatedModifyInstanceRequest(
service_user_id=...,
unassign_phone_numbers=...,
add_phone_number_to_group=...,
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=...,
agent_weight_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=...,
service_list=...,
is_active=...,
directory_number_hunting_agent_user_id_list=...,
directory_number_hunting_use_terminate_call_to_agent_first=...,
directory_number_hunting_use_original_agent_services_for_busy_and_no_answer_calls=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("GroupHuntGroupConsolidatedModifyInstanceRequest",
service_user_id=...,
unassign_phone_numbers=...,
add_phone_number_to_group=...,
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=...,
agent_weight_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=...,
service_list=...,
is_active=...,
directory_number_hunting_agent_user_id_list=...,
directory_number_hunting_use_terminate_call_to_agent_first=...,
directory_number_hunting_use_original_agent_services_for_busy_and_no_answer_calls=...,
)
print(response)