Skip to content

GroupCallCenterModifyRequest

Bases: OCIRequest

Modify the group level data associated with Call Center and the active status of Call Center instances. The response is either a SuccessResponse or an ErrorResponse.

The following elements are only used in AS data mode and ignored in XS data mode:
  useSystemDefaultUnavailableSettings
  forceAgentUnavailableOnDNDActivation
  forceAgentUnavailableOnPersonalCalls
  forceAgentUnavailableOnBouncedCallLimit
  numberConsecutiveBouncedCallsToForceAgentUnavailable
  forceAgentUnavailableOnNotReachable
  wrapUpDestination

Attributes:

service_provider_id (str):

group_id (str):

use_system_default_guard_timer (Optional[bool]):

enable_guard_timer (Optional[bool]):

guard_timer_seconds (Optional[int]):

use_system_default_unavailable_settings (Optional[bool]):

force_agent_unavailable_on_dnd_activation (Optional[bool]):

force_agent_unavailable_on_personal_calls (Optional[bool]):

force_agent_unavailable_on_bounced_call_limit (Optional[bool]):

number_consecutive_bounced_calls_to_force_agent_unavailable (Optional[int]):

force_agent_unavailable_on_not_reachable (Optional[bool]):

wrap_up_destination (Optional[Nillable[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterModifyRequest(OCIRequest):
    """Modify the group level data associated with Call Center and
        the active status of Call Center instances.
        The response is either a SuccessResponse or an ErrorResponse.

        The following elements are only used in AS data mode and ignored in XS data mode:
          useSystemDefaultUnavailableSettings
          forceAgentUnavailableOnDNDActivation
          forceAgentUnavailableOnPersonalCalls
          forceAgentUnavailableOnBouncedCallLimit
          numberConsecutiveBouncedCallsToForceAgentUnavailable
          forceAgentUnavailableOnNotReachable
          wrapUpDestination

    Attributes:

        service_provider_id (str):

        group_id (str):

        use_system_default_guard_timer (Optional[bool]):

        enable_guard_timer (Optional[bool]):

        guard_timer_seconds (Optional[int]):

        use_system_default_unavailable_settings (Optional[bool]):

        force_agent_unavailable_on_dnd_activation (Optional[bool]):

        force_agent_unavailable_on_personal_calls (Optional[bool]):

        force_agent_unavailable_on_bounced_call_limit (Optional[bool]):

        number_consecutive_bounced_calls_to_force_agent_unavailable (Optional[int]):

        force_agent_unavailable_on_not_reachable (Optional[bool]):

        wrap_up_destination (Optional[Nillable[str]]):

    """

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["wrap_up_destination"]
        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/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupCallCenterModifyRequest

client = Client()

command = GroupCallCenterModifyRequest(
    service_provider_id=...,
    group_id=...,
    use_system_default_guard_timer=...,
    enable_guard_timer=...,
    guard_timer_seconds=...,
    use_system_default_unavailable_settings=...,
    force_agent_unavailable_on_dnd_activation=...,
    force_agent_unavailable_on_personal_calls=...,
    force_agent_unavailable_on_bounced_call_limit=...,
    number_consecutive_bounced_calls_to_force_agent_unavailable=...,
    force_agent_unavailable_on_not_reachable=...,
    wrap_up_destination=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterModifyRequest",
    service_provider_id=...,
    group_id=...,
    use_system_default_guard_timer=...,
    enable_guard_timer=...,
    guard_timer_seconds=...,
    use_system_default_unavailable_settings=...,
    force_agent_unavailable_on_dnd_activation=...,
    force_agent_unavailable_on_personal_calls=...,
    force_agent_unavailable_on_bounced_call_limit=...,
    number_consecutive_bounced_calls_to_force_agent_unavailable=...,
    force_agent_unavailable_on_not_reachable=...,
    wrap_up_destination=...,
)

print(response)