Skip to content

UserCallCenterGetRequest23

Bases: OCIRequest

Get the user's call center settings and the list of call centers the specified user belongs to. The response is either a UserCallCenterGetResponse23 or an ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterGetRequest23(OCIRequest):
    """Get the user's call center settings and the list of call centers the specified user belongs to.
        The response is either a UserCallCenterGetResponse23 or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserCallCenterGetRequest23. Contains the user's call center settings. Indicates whether the agent is current available (logged in) to each call center in the list. Contains a table with column headings: "Service User Id", "Phone Number", "Extension", "Available", "Logoff Allowed", "Type", "Priority","Routing Policy" and "Skill Level". The valid "Routing Type" values are "Priority Based" and "Skill Based". This column is only populated for Premium Call Centers. The valid "Skill Level" values are of from 1-20. This column is only populated for Premium Skill Based Call Centers.

The following elements are only used in AS data mode and not returned in XS data mode:
  agentACDState
  agentThresholdProfileName
  agentUnavailableCode
  useSystemDefaultUnavailableSettings
  forceAgentUnavailableOnDNDActivation
  forceAgentUnavailableOnPersonalCalls
  forceAgentUnavailableOnBouncedCallLimit
  numberConsecutiveBouncedCallsToForceAgentUnavailable
  forceAgentUnavailableOnNotReachable
  makeOutgoingCallsAsCallCenter
  outgoingCallDNIS
  useSystemDefaultWrapUpDestination
  wrapUpDestination

The following columns are only used in AS data mode and not returned in XS data mode:
  "Routing Policy"
  "Skill Level"

Attributes:

agent_acd_state (Optional[str]):

agent_threshold_profile_name (Optional[str]):

agent_unavailable_code (Optional[str]):

use_default_guard_timer (bool):

enable_guard_timer (bool):

guard_timer_seconds (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[DNISKey]):

use_system_default_wrap_up_destination (Optional[bool]):

wrap_up_destination (Optional[str]):

call_center_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterGetResponse23(OCIDataResponse):
    """Response to the UserCallCenterGetRequest23.
        Contains the user's call center settings.
        Indicates whether the agent is current available (logged in) to each call center in the list.
        Contains a table with column headings: \"Service User Id\", \"Phone Number\", \"Extension\", \"Available\", \"Logoff Allowed\", \"Type\",
         \"Priority\",\"Routing Policy\" and \"Skill Level\".
        The valid \"Routing Type\" values are \"Priority Based\" and \"Skill Based\". This column is only populated for Premium Call Centers.
        The valid \"Skill Level\" values are of from 1-20. This column is only populated for Premium Skill Based Call Centers.

        The following elements are only used in AS data mode and not returned in XS data mode:
          agentACDState
          agentThresholdProfileName
          agentUnavailableCode
          useSystemDefaultUnavailableSettings
          forceAgentUnavailableOnDNDActivation
          forceAgentUnavailableOnPersonalCalls
          forceAgentUnavailableOnBouncedCallLimit
          numberConsecutiveBouncedCallsToForceAgentUnavailable
          forceAgentUnavailableOnNotReachable
          makeOutgoingCallsAsCallCenter
          outgoingCallDNIS
          useSystemDefaultWrapUpDestination
          wrapUpDestination

        The following columns are only used in AS data mode and not returned in XS data mode:
          \"Routing Policy\"
          \"Skill Level\"

    Attributes:

        agent_acd_state (Optional[str]):

        agent_threshold_profile_name (Optional[str]):

        agent_unavailable_code (Optional[str]):

        use_default_guard_timer (bool):

        enable_guard_timer (bool):

        guard_timer_seconds (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[DNISKey]):

        use_system_default_wrap_up_destination (Optional[bool]):

        wrap_up_destination (Optional[str]):

        call_center_table (OCITable):

    """

    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[str] = field(
        default=None, metadata={"alias": "agentUnavailableCode"}
    )

    use_default_guard_timer: bool = field(metadata={"alias": "useDefaultGuardTimer"})

    enable_guard_timer: bool = field(metadata={"alias": "enableGuardTimer"})

    guard_timer_seconds: int = field(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[DNISKey] = field(
        default=None, metadata={"alias": "outgoingCallDNIS"}
    )

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

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

    call_center_table: OCITable = field(metadata={"alias": "callCenterTable"})

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 UserCallCenterGetRequest23

client = Client()

command = UserCallCenterGetRequest23(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCallCenterGetRequest23",
    user_id=...,
)

print(response)