UserCallCenterAgentSignOutRequest

Bases: OCIRequest

This request signs-out a call center agent. Administrator, supervisor and agent itself can sign-out an agent. An empty OCI table in OCI-P response indicates success and the agent has been signed out. This sign-out command will fail if the agent is the last signed-in agent of any standard or premium call center to which she is currently joined. If the sign-out fails, the OCI-P response will contain a list of Call Centers for which the agent is the last signed-in agent. If this special logic is not needed, UserCallCenterModifyRequest19 can still be used to change the agents ACD state without checking if the agent is the last signed-in agent. The response is either a UserCallCenterAgentSignOutResponse or ErrorResponse.

Attributes:

agent_user_id (str):

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

@dataclass(kw_only=True)
class UserCallCenterAgentSignOutRequest(OCIRequest):
    """This request signs-out a call center agent. Administrator, supervisor and agent itself can sign-out an agent.
        An empty OCI table in OCI-P response indicates success and the agent has been signed out. This sign-out
        command will fail if the agent is the last signed-in agent of any standard or premium call center to
        which she is currently joined. If the sign-out fails, the OCI-P response will contain a list of
        Call Centers for which the agent is the last signed-in agent.
        If this special logic is not needed, UserCallCenterModifyRequest19 can still be used to change
        the agents ACD state without checking if the agent is the last signed-in agent.
        The response is either a UserCallCenterAgentSignOutResponse or ErrorResponse.

    Attributes:

        agent_user_id (str):

    """

    agent_user_id: str = field(metadata={"alias": "agentUserId"})

Responses

Bases: OCIDataResponse

Response to the UserCallCenterAgentSignOutRequest. It contains a list of call centers for which the agent is the last signed-in agent. Contains a table with column headings: "Service User Id" and "Call Center Name".

Attributes:

call_center_table (OCITable):

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

@dataclass(kw_only=True)
class UserCallCenterAgentSignOutResponse(OCIDataResponse):
    """Response to the UserCallCenterAgentSignOutRequest.
        It contains a list of call centers for which the agent is the last signed-in agent.
        Contains a table with column headings: \"Service User Id\" and \"Call Center Name\".

    Attributes:

        call_center_table (OCITable):

    """

    call_center_table: OCITable = field(metadata={"alias": "callCenterTable"})

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 UserCallCenterAgentSignOutRequest

client = Client()

command = UserCallCenterAgentSignOutRequest(
    agent_user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCallCenterAgentSignOutRequest",
    agent_user_id=...,
)

print(response)