GroupCallCenterGetInstanceListRequest

Bases: OCIRequest

Get a list of Call Center instances within a group. The response is either GroupCallCenterGetInstanceListResponse or ErrorResponse. It is possible to get the instances within a specified department.

Attributes:

service_provider_id (str):

group_id (str):

group_department_name (Optional[str]):

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

@dataclass(kw_only=True)
class GroupCallCenterGetInstanceListRequest(OCIRequest):
    """Get a list of Call Center instances within a group.
        The response is either GroupCallCenterGetInstanceListResponse or ErrorResponse.
        It is possible to get the instances within a specified department.

    Attributes:

        service_provider_id (str):

        group_id (str):

        group_department_name (Optional[str]):

    """

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

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

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

Responses

Bases: OCIDataResponse

Response to the GroupCallCenterGetInstanceListRequest. Contains a table with column headings: "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active", "Policy", "Type". The column values for "Video" and "Is Active" can either be true, or false. The column values for "Type" can be "Basic", "Standard" or "Premium" in AS data mode and "Basic" in XS data mode. NOTE: prior to release 14, the policy column did not match the HuntPolicy enumerated type.

Attributes:

call_center_table (OCITable):

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

@dataclass(kw_only=True)
class GroupCallCenterGetInstanceListResponse(OCIDataResponse):
    """Response to the GroupCallCenterGetInstanceListRequest.
        Contains a table with column headings:
        \"Service User Id\", \"Name\", \"Video\", \"Phone Number\", \"Extension\", \"Department\", \"Is Active\", \"Policy\", \"Type\".
        The column values for \"Video\" and \"Is Active\" can either be true, or false.
        The column values for \"Type\" can be \"Basic\", \"Standard\" or \"Premium\" in AS data mode and \"Basic\" in XS data mode.
        NOTE: prior to release 14, the policy column did not match the HuntPolicy enumerated type.

    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 GroupCallCenterGetInstanceListRequest

client = Client()

command = GroupCallCenterGetInstanceListRequest(
    service_provider_id=...,
    group_id=...,
    group_department_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterGetInstanceListRequest",
    service_provider_id=...,
    group_id=...,
    group_department_name=...,
)

print(response)