UserCallCenterGetAvailableDNISListRequest

Bases: OCIRequest

Request a list of available DNIS for agent to select. The response is either UserCallCenterGetAvailableDNISListResponse or ErrorResponse.

Attributes:

agent_user_id (str):

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

@dataclass(kw_only=True)
class UserCallCenterGetAvailableDNISListRequest(OCIRequest):
    """Request a list of available DNIS for agent to select.
        The response is either UserCallCenterGetAvailableDNISListResponse or ErrorResponse.

    Attributes:

        agent_user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserCallCenterGetAvailableDNISListRequest. Contains a list of available DNIS for agent to select.

Attributes:

available_dnis (Optional[List[DNISKey]]):

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

@dataclass(kw_only=True)
class UserCallCenterGetAvailableDNISListResponse(OCIDataResponse):
    """Response to UserCallCenterGetAvailableDNISListRequest.
        Contains a list of available DNIS for agent to select.

    Attributes:

        available_dnis (Optional[List[DNISKey]]):

    """

    available_dnis: Optional[List[DNISKey]] = field(
        default=None, metadata={"alias": "availableDNIS"}
    )

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 UserCallCenterGetAvailableDNISListRequest

client = Client()

command = UserCallCenterGetAvailableDNISListRequest(
    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("UserCallCenterGetAvailableDNISListRequest",
    agent_user_id=...,
)

print(response)