GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest

Bases: OCIRequest

Get the list of all Agents in the Group that can be assigned to a given Call Center Agent Threshold Profile in a Group. An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent and the agent is not yet assigned to the profile. The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name. The response is either a GroupCallCenterAgentThresholdProfileGetAvailableAgentListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

exclude_agents_assigned_to_profile_name (Optional[str]):

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_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_agent_threshold_profile (Optional[List[SearchCriteriaAgentThresholdProfile]]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest(OCIRequest):
    """Get the list of all Agents in the Group that can be assigned to a given Call Center Agent Threshold Profile in a Group.
        An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent
        and the agent is not yet assigned to the profile.
        The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName.
        When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search
        criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name.
        The response is either a GroupCallCenterAgentThresholdProfileGetAvailableAgentListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        exclude_agents_assigned_to_profile_name (Optional[str]):

        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_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_agent_threshold_profile (Optional[List[SearchCriteriaAgentThresholdProfile]]):

    """

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

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

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

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

    search_criteria_agent_threshold_profile: Optional[
        List[SearchCriteriaAgentThresholdProfile]
    ] = field(default=None, metadata={"alias": "searchCriteriaAgentThresholdProfile"})

Responses

Bases: OCIDataResponse

Response to the GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "Agent Threshold Profile";

Attributes:

agent_table (OCITable):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupCallCenterAgentThresholdProfileGetAvailableAgentListResponse(
    OCIDataResponse
):
    """Response to the GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\",
        \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\", \"Agent Threshold Profile\";

    Attributes:

        agent_table (OCITable):

    """

    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 GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest

client = Client()

command = GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest(
    service_provider_id=...,
    group_id=...,
    exclude_agents_assigned_to_profile_name=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_agent_threshold_profile=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest",
    service_provider_id=...,
    group_id=...,
    exclude_agents_assigned_to_profile_name=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_agent_threshold_profile=...,
)

print(response)