Skip to content

EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest

Bases: OCIRequest

Gets an existing default Call Center Agent Threshold Profile in an Enterprise. If includeAgentsTable is set to true, a table with the list of agents assigned to the profile is included in the response. The search criteria is used to filter the list of agents to be included in the table. The response is either a EnterpriseCallCenterAgentThresholdDefaultProfileGetResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

include_agents_table (bool):

response_size_limit (Optional[int]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest(OCIRequest):
    """Gets an existing default Call Center Agent Threshold Profile in an Enterprise.
        If includeAgentsTable is set to true, a table with the list of agents assigned to
        the profile is included in the response. The search criteria is used to filter the
        list of agents to be included in the table.
        The response is either a EnterpriseCallCenterAgentThresholdDefaultProfileGetResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        include_agents_table (bool):

        response_size_limit (Optional[int]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

    """

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

    include_agents_table: bool = field(metadata={"alias": "includeAgentsTable"})

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

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

    search_criteria_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

    search_criteria_exact_user_group: Optional[SearchCriteriaExactUserGroup] = field(
        default=None, metadata={"alias": "searchCriteriaExactUserGroup"}
    )

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

Responses

Bases: OCIDataResponse

Response to the EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest. The agent table contains the agents assigned to the profile and has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address";

Attributes:

profile_name (str):

profile_description (Optional[str]):

threshold_current_call_state_idle_time_yellow (Optional[int]):

threshold_current_call_state_idle_time_red (Optional[int]):

threshold_current_call_state_on_call_time_yellow (Optional[int]):

threshold_current_call_state_on_call_time_red (Optional[int]):

threshold_current_agent_state_unavailable_time_yellow (Optional[int]):

threshold_current_agent_state_unavailable_time_red (Optional[int]):

threshold_average_busy_in_time_yellow (Optional[int]):

threshold_average_busy_in_time_red (Optional[int]):

threshold_average_busy_out_time_yellow (Optional[int]):

threshold_average_busy_out_time_red (Optional[int]):

threshold_average_wrap_up_time_yellow (Optional[int]):

threshold_average_wrap_up_time_red (Optional[int]):

enable_notification_email (bool):

notification_email_address (Optional[List[str]]):

agent_table (Optional[OCITable]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseCallCenterAgentThresholdDefaultProfileGetResponse(OCIDataResponse):
    """Response to the EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest.
        The agent table contains the agents assigned to the profile and
        has column headings: \"User Id\", \"Last Name\",
        \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\";

    Attributes:

        profile_name (str):

        profile_description (Optional[str]):

        threshold_current_call_state_idle_time_yellow (Optional[int]):

        threshold_current_call_state_idle_time_red (Optional[int]):

        threshold_current_call_state_on_call_time_yellow (Optional[int]):

        threshold_current_call_state_on_call_time_red (Optional[int]):

        threshold_current_agent_state_unavailable_time_yellow (Optional[int]):

        threshold_current_agent_state_unavailable_time_red (Optional[int]):

        threshold_average_busy_in_time_yellow (Optional[int]):

        threshold_average_busy_in_time_red (Optional[int]):

        threshold_average_busy_out_time_yellow (Optional[int]):

        threshold_average_busy_out_time_red (Optional[int]):

        threshold_average_wrap_up_time_yellow (Optional[int]):

        threshold_average_wrap_up_time_red (Optional[int]):

        enable_notification_email (bool):

        notification_email_address (Optional[List[str]]):

        agent_table (Optional[OCITable]):

    """

    profile_name: str = field(metadata={"alias": "profileName"})

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

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

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

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

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

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

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

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

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

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

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

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

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

    enable_notification_email: bool = field(
        metadata={"alias": "enableNotificationEmail"}
    )

    notification_email_address: Optional[List[str]] = field(
        default=None, metadata={"alias": "notificationEmailAddress"}
    )

    agent_table: Optional[OCITable] = field(
        default=None, metadata={"alias": "agentTable"}
    )

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 EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest

client = Client()

command = EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest(
    service_provider_id=...,
    include_agents_table=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest",
    service_provider_id=...,
    include_agents_table=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
)

print(response)