Skip to content

GroupCallCenterModifyAgentListRequest

Bases: OCIRequest

Request to modify the agent list for a call center. The response is either SuccessResponse or ErrorResponse. If the agentUserIdList is used for Skill Based Premium call centers, the agents will be set to skill level 1.

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

Attributes:

service_user_id (str):

agent_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

skilled_agent_user_id_list (Optional[List[CallCenterReplacementSkilledAgents]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterModifyAgentListRequest(OCIRequest):
    """Request to modify the agent list for a call center.
        The response is either SuccessResponse or ErrorResponse.
        If the agentUserIdList is used for Skill Based Premium call centers,
        the agents will be set to skill level 1.

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

    Attributes:

        service_user_id (str):

        agent_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

        skilled_agent_user_id_list (Optional[List[CallCenterReplacementSkilledAgents]]):

    """

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

    agent_user_id_list: Optional[Nillable[ReplacementUserIdList]] = field(
        default=None, metadata={"alias": "agentUserIdList"}
    )

    skilled_agent_user_id_list: Optional[List[CallCenterReplacementSkilledAgents]] = (
        field(default=None, metadata={"alias": "skilledAgentUserIdList"})
    )

    def __post_init__(self):
        nillable_fields = ["agent_user_id_list"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 GroupCallCenterModifyAgentListRequest

client = Client()

command = GroupCallCenterModifyAgentListRequest(
    service_user_id=...,
    agent_user_id_list=...,
    skilled_agent_user_id_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterModifyAgentListRequest",
    service_user_id=...,
    agent_user_id_list=...,
    skilled_agent_user_id_list=...,
)

print(response)