Skip to content

UserCallCenterModifyRequest19

Bases: OCIRequest

Modifies the agents call center settings and the availability for an agent in one or more Call Centers. Contains a list specifying the desired availability status of one or more call centers. A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code. 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:
  agentACDState
  agentThresholdProfileName
  agentUnavailableCode
  useSystemDefaultUnavailableSettings
  forceAgentUnavailableOnDNDActivation
  forceAgentUnavailableOnPersonalCalls
  forceAgentUnavailableOnBouncedCallLimit
  numberConsecutiveBouncedCallsToForceAgentUnavailable
  forceAgentUnavailableOnNotReachable
  makeOutgoingCallsAsCallCenter
  outgoingCallDNIS
  useSystemDefaultWrapUpDestination
  wrapUpDestination

Attributes:

user_id (str):

agent_acd_state (Optional[str]):

agent_threshold_profile_name (Optional[str]):

agent_unavailable_code (Optional[Nillable[str]]):

use_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]):

make_outgoing_calls_as_call_center (Optional[bool]):

outgoing_call_dnis (Optional[Nillable[DNISKey]]):

call_center_agent_settings (Optional[List[CallCenterAgentSettings]]):

use_system_default_wrap_up_destination (Optional[bool]):

wrap_up_destination (Optional[Nillable[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterModifyRequest19(OCIRequest):
    """Modifies the agents call center settings and the availability for an agent in one or more Call Centers.
        Contains a list specifying the desired availability status of one or more call centers.
        A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid.
        Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code.
        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:
          agentACDState
          agentThresholdProfileName
          agentUnavailableCode
          useSystemDefaultUnavailableSettings
          forceAgentUnavailableOnDNDActivation
          forceAgentUnavailableOnPersonalCalls
          forceAgentUnavailableOnBouncedCallLimit
          numberConsecutiveBouncedCallsToForceAgentUnavailable
          forceAgentUnavailableOnNotReachable
          makeOutgoingCallsAsCallCenter
          outgoingCallDNIS
          useSystemDefaultWrapUpDestination
          wrapUpDestination

    Attributes:

        user_id (str):

        agent_acd_state (Optional[str]):

        agent_threshold_profile_name (Optional[str]):

        agent_unavailable_code (Optional[Nillable[str]]):

        use_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]):

        make_outgoing_calls_as_call_center (Optional[bool]):

        outgoing_call_dnis (Optional[Nillable[DNISKey]]):

        call_center_agent_settings (Optional[List[CallCenterAgentSettings]]):

        use_system_default_wrap_up_destination (Optional[bool]):

        wrap_up_destination (Optional[Nillable[str]]):

    """

    user_id: str = field(metadata={"alias": "userId"})

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

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

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

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

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

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

    outgoing_call_dnis: Optional[Nillable[DNISKey]] = field(
        default=None, metadata={"alias": "outgoingCallDNIS"}
    )

    call_center_agent_settings: Optional[List[CallCenterAgentSettings]] = field(
        default=None, metadata={"alias": "callCenterAgentSettings"}
    )

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

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

    def __post_init__(self):
        nillable_fields = [
            "agent_unavailable_code",
            "outgoing_call_dnis",
            "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_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 UserCallCenterModifyRequest19

client = Client()

command = UserCallCenterModifyRequest19(
    user_id=...,
    agent_acd_state=...,
    agent_threshold_profile_name=...,
    agent_unavailable_code=...,
    use_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=...,
    make_outgoing_calls_as_call_center=...,
    outgoing_call_dnis=...,
    call_center_agent_settings=...,
    use_system_default_wrap_up_destination=...,
    wrap_up_destination=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCallCenterModifyRequest19",
    user_id=...,
    agent_acd_state=...,
    agent_threshold_profile_name=...,
    agent_unavailable_code=...,
    use_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=...,
    make_outgoing_calls_as_call_center=...,
    outgoing_call_dnis=...,
    call_center_agent_settings=...,
    use_system_default_wrap_up_destination=...,
    wrap_up_destination=...,
)

print(response)