GroupCallCenterGetAgentListRequest

Bases: OCIRequest

Get a list of agents assigned to a call center. The response is either a GroupCallCenterGetAgentListResponse or an ErrorResponse.

The following element is only used in AS data mode and ignored in XS data mode:
  searchCriteriaExactSkillLevel

Attributes:

service_user_id (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_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_exact_skill_level (Optional[SearchCriteriaExactSkillLevel]):

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

@dataclass(kw_only=True)
class GroupCallCenterGetAgentListRequest(OCIRequest):
    """Get a list of agents assigned to a call center.
        The response is either a
        GroupCallCenterGetAgentListResponse or an ErrorResponse.

        The following element is only used in AS data mode and ignored in XS data mode:
          searchCriteriaExactSkillLevel

    Attributes:

        service_user_id (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_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_exact_skill_level (Optional[SearchCriteriaExactSkillLevel]):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

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

    search_criteria_exact_skill_level: Optional[SearchCriteriaExactSkillLevel] = field(
        default=None, metadata={"alias": "searchCriteriaExactSkillLevel"}
    )

Responses

Bases: OCIDataResponse

Response to the GroupCallCenterGetAgentListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Weight", "Phone Number", "Extension", "Department", "Email Address", "Skill Level".

The following column is only returned in AS data mode:
  "Skill Level"

Attributes:

agent_table (OCITable):

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

@dataclass(kw_only=True)
class GroupCallCenterGetAgentListResponse(OCIDataResponse):
    """Response to the GroupCallCenterGetAgentListRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\",
        \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\", \"Weight\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\", \"Skill Level\".

        The following column is only returned in AS data mode:
          \"Skill Level\"

    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 GroupCallCenterGetAgentListRequest

client = Client()

command = GroupCallCenterGetAgentListRequest(
    service_user_id=...,
    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=...,
    search_criteria_exact_skill_level=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterGetAgentListRequest",
    service_user_id=...,
    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=...,
    search_criteria_exact_skill_level=...,
)

print(response)