Skip to content

GroupCallCenterAgentThresholdProfileGetPagedSortedRequest

Bases: OCIRequest

Gets an existing non-default Call Center Agent Threshold Profile in a Group.

If the responsePagingControl element is not provided, the paging startIndex will be set to 1
by default, and the responsePageSize will be set to the maximum ResponsePageSize by default.
It is possible to search by various criteria to restrict the number of rows returned.

If no sortOrder is included the response is sorted by User Id ascending by default.

Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
Then the search criteria are logically ORed together.

The response is either a GroupCallCenterAgentThresholdProfileGetPagedSortedResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

profile_name (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterAgentThresholdProfileGetPagedSortedRequest(OCIRequest):
    """Gets an existing non-default Call Center Agent Threshold Profile in a Group.

        If the responsePagingControl element is not provided, the paging startIndex will be set to 1
        by default, and the responsePageSize will be set to the maximum ResponsePageSize by default.
        It is possible to search by various criteria to restrict the number of rows returned.

        If no sortOrder is included the response is sorted by User Id ascending by default.

        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
        Then the search criteria are logically ORed together.

        The response is either a GroupCallCenterAgentThresholdProfileGetPagedSortedResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        profile_name (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

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

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

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_order: Optional[
        List[SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted]
    ] = field(default=None, metadata={"alias": "sortOrder"})

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

    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_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

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

    search_criteria_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

    search_criteria_email_address: Optional[List[SearchCriteriaEmailAddress]] = field(
        default=None, metadata={"alias": "searchCriteriaEmailAddress"}
    )

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

Responses

Bases: OCIDataResponse

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

Attributes:

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 (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterAgentThresholdProfileGetPagedSortedResponse(OCIDataResponse):
    """Response to the GroupCallCenterAgentThresholdProfileGetPagedSortedRequest.
        The agentTable contains the agents assigned to the profile and has the column headings:
        \"User Id\", \"Group Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\";

    Attributes:

        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 (OCITable):

    """

    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: OCITable = field(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 GroupCallCenterAgentThresholdProfileGetPagedSortedRequest

client = Client()

command = GroupCallCenterAgentThresholdProfileGetPagedSortedRequest(
    service_provider_id=...,
    group_id=...,
    profile_name=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_department_name=...,
    search_criteria_email_address=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterAgentThresholdProfileGetPagedSortedRequest",
    service_provider_id=...,
    group_id=...,
    profile_name=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_department_name=...,
    search_criteria_email_address=...,
    search_criteria_mode_or=...,
)

print(response)