GroupVoiceXmlGetInstanceRequest23

Bases: OCIRequest

Request to get all the information of a VoiceXML instance. The response is either GroupVoiceXmlGetInstanceResponse23 or ErrorResponse.

Attributes:

service_user_id (str):

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

@dataclass(kw_only=True)
class GroupVoiceXmlGetInstanceRequest23(OCIRequest):
    """Request to get all the information of a VoiceXML instance.
        The response is either GroupVoiceXmlGetInstanceResponse23 or ErrorResponse.

    Attributes:

        service_user_id (str):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

Responses

Bases: OCIDataResponse

Response to GroupVoiceXmlGetInstanceRequest23. Contains the service profile information and possibly access device information.

Attributes:

service_instance_profile (ServiceInstanceReadProfile19sp1):

network_class_of_service (Optional[str]):

access_device_endpoint (Optional[AccessDeviceEndpointWithPortNumberRead22]):

webex_meeting_callback (bool):

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

@dataclass(kw_only=True)
class GroupVoiceXmlGetInstanceResponse23(OCIDataResponse):
    """Response to GroupVoiceXmlGetInstanceRequest23.
        Contains the service profile information and possibly access device information.

    Attributes:

        service_instance_profile (ServiceInstanceReadProfile19sp1):

        network_class_of_service (Optional[str]):

        access_device_endpoint (Optional[AccessDeviceEndpointWithPortNumberRead22]):

        webex_meeting_callback (bool):

    """

    service_instance_profile: ServiceInstanceReadProfile19sp1 = field(
        metadata={"alias": "serviceInstanceProfile"}
    )

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

    access_device_endpoint: Optional[AccessDeviceEndpointWithPortNumberRead22] = field(
        default=None, metadata={"alias": "accessDeviceEndpoint"}
    )

    webex_meeting_callback: bool = field(metadata={"alias": "webexMeetingCallback"})

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 GroupVoiceXmlGetInstanceRequest23

client = Client()

command = GroupVoiceXmlGetInstanceRequest23(
    service_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("GroupVoiceXmlGetInstanceRequest23",
    service_user_id=...,
)

print(response)