Skip to content

SystemCallCenterModifyRequest

Bases: OCIRequest

Modify the system level data associated with Call Center. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

default_from_address (Optional[str]):

statistics_sampling_period_minutes (Optional[int]):

default_enable_guard_timer (Optional[bool]):

default_guard_timer_seconds (Optional[int]):

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

default_play_ring_when_offer_call (Optional[bool]):

uniform_call_distribution_policy_scope (Optional[str]):

call_handling_sampling_period_minutes (Optional[int]):

call_handling_minimum_sampling_size (Optional[int]):

play_tone_to_agent_for_emergency_call (Optional[bool]):

emergency_call_clid_prefix (Optional[str]):

threshold_crossing_notification_email_guard_timer_seconds (Optional[int]):

allow_agent_device_initiated_forward (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemCallCenterModifyRequest(OCIRequest):
    """Modify the system level data associated with Call Center.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        default_from_address (Optional[str]):

        statistics_sampling_period_minutes (Optional[int]):

        default_enable_guard_timer (Optional[bool]):

        default_guard_timer_seconds (Optional[int]):

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

        default_play_ring_when_offer_call (Optional[bool]):

        uniform_call_distribution_policy_scope (Optional[str]):

        call_handling_sampling_period_minutes (Optional[int]):

        call_handling_minimum_sampling_size (Optional[int]):

        play_tone_to_agent_for_emergency_call (Optional[bool]):

        emergency_call_clid_prefix (Optional[str]):

        threshold_crossing_notification_email_guard_timer_seconds (Optional[int]):

        allow_agent_device_initiated_forward (Optional[bool]):

    """

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

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

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

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

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

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

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

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

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

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

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

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

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

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 SystemCallCenterModifyRequest

client = Client()

command = SystemCallCenterModifyRequest(
    default_from_address=...,
    statistics_sampling_period_minutes=...,
    default_enable_guard_timer=...,
    default_guard_timer_seconds=...,
    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=...,
    default_play_ring_when_offer_call=...,
    uniform_call_distribution_policy_scope=...,
    call_handling_sampling_period_minutes=...,
    call_handling_minimum_sampling_size=...,
    play_tone_to_agent_for_emergency_call=...,
    emergency_call_clid_prefix=...,
    threshold_crossing_notification_email_guard_timer_seconds=...,
    allow_agent_device_initiated_forward=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemCallCenterModifyRequest",
    default_from_address=...,
    statistics_sampling_period_minutes=...,
    default_enable_guard_timer=...,
    default_guard_timer_seconds=...,
    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=...,
    default_play_ring_when_offer_call=...,
    uniform_call_distribution_policy_scope=...,
    call_handling_sampling_period_minutes=...,
    call_handling_minimum_sampling_size=...,
    play_tone_to_agent_for_emergency_call=...,
    emergency_call_clid_prefix=...,
    threshold_crossing_notification_email_guard_timer_seconds=...,
    allow_agent_device_initiated_forward=...,
)

print(response)