GroupVoiceXmlGetInstanceListRequest

Bases: OCIRequest

Get a list of VoiceXML instances within a group. The response is either GroupVoiceXmlGetInstanceListResponse 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 GroupVoiceXmlGetInstanceListRequest(OCIRequest):
    """Get a list of VoiceXML instances within a group.
        The response is either GroupVoiceXmlGetInstanceListResponse 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 GroupVoiceXmlGetInstanceListRequest. Contains a table with column headings: "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active" and "Is Webex Meeting Callback". The column values for "Is Active" can either be true, or false.

Attributes:

voice_xml_table (OCITable):

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

@dataclass(kw_only=True)
class GroupVoiceXmlGetInstanceListResponse(OCIDataResponse):
    """Response to the GroupVoiceXmlGetInstanceListRequest.
        Contains a table with column headings:
        \"Service User Id\", \"Name\", \"Phone Number\", \"Extension\", \"Department\", \"Is Active\"
        and \"Is Webex Meeting Callback\".
        The column values for \"Is Active\" can either be true, or false.

    Attributes:

        voice_xml_table (OCITable):

    """

    voice_xml_table: OCITable = field(metadata={"alias": "voiceXmlTable"})

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 GroupVoiceXmlGetInstanceListRequest

client = Client()

command = GroupVoiceXmlGetInstanceListRequest(
    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("GroupVoiceXmlGetInstanceListRequest",
    service_provider_id=...,
    group_id=...,
    group_department_name=...,
)

print(response)