GroupAutoAttendantGetInstanceListRequest

Bases: OCIRequest

Get a list of Auto Attendant instances within a group. The response is either GroupAutoAttendantGetInstanceListResponse 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_fast/commands/commands.py

@dataclass(kw_only=True)
class GroupAutoAttendantGetInstanceListRequest(OCIRequest):
    """Get a list of Auto Attendant instances within a group.
        The response is either GroupAutoAttendantGetInstanceListResponse 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 GroupAutoAttendantGetInstanceListRequest. Contains a table with column headings: "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active", "Type". The column values for "Video" and "Is Active" can either be true, or false. The column values for "Type" can either be Basic or Standard.

In XS Mode the value for the "Type" column will always be populated with Basic.

Attributes:

auto_attendant_table (OCITable):

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

@dataclass(kw_only=True)
class GroupAutoAttendantGetInstanceListResponse(OCIDataResponse):
    """Response to the GroupAutoAttendantGetInstanceListRequest.
        Contains a table with column headings:
        \"Service User Id\", \"Name\", \"Video\", \"Phone Number\", \"Extension\", \"Department\", \"Is Active\", \"Type\".
        The column values for \"Video\" and \"Is Active\" can either be true, or false.
        The column values for \"Type\" can either be Basic or Standard.

        In XS Mode the value for the \"Type\" column will always be populated with Basic.

    Attributes:

        auto_attendant_table (OCITable):

    """

    auto_attendant_table: OCITable = field(metadata={"alias": "autoAttendantTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupAutoAttendantGetInstanceListRequest

client = Client()

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

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

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

print(response)