GroupVoiceXmlAddInstanceRequest

Bases: OCIRequest

Add a VoiceXML instance to a group. The domain is required in the serviceUserId. For a valid voiceXml instance to work properly, a device with Static Registration is expected with a valid contact. If not set, The webexMeetingCallback element will be set to "false". The following elements are only used in AS data mode and ignored in XS data mode: webexMeetingCallback

The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

service_instance_profile (ServiceInstanceAddProfile):

network_class_of_service (Optional[str]):

access_device_endpoint (Optional[AccessDeviceEndpointAdd]):

webex_meeting_callback (Optional[bool]):

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

@dataclass(kw_only=True)
class GroupVoiceXmlAddInstanceRequest(OCIRequest):
    """Add a VoiceXML instance to a group.
        The domain is required in the serviceUserId.  For a valid voiceXml instance to work properly,
        a device with Static Registration is expected with a valid contact.
        If not set, The webexMeetingCallback element will be set to \"false\".
        The following elements are only used in AS data mode and ignored in XS data mode:
          webexMeetingCallback

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        service_instance_profile (ServiceInstanceAddProfile):

        network_class_of_service (Optional[str]):

        access_device_endpoint (Optional[AccessDeviceEndpointAdd]):

        webex_meeting_callback (Optional[bool]):

    """

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

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

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

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

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

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

    webex_meeting_callback: Optional[bool] = field(
        default=None, metadata={"alias": "webexMeetingCallback"}
    )

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 GroupVoiceXmlAddInstanceRequest

client = Client()

command = GroupVoiceXmlAddInstanceRequest(
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    network_class_of_service=...,
    access_device_endpoint=...,
    webex_meeting_callback=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupVoiceXmlAddInstanceRequest",
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    network_class_of_service=...,
    access_device_endpoint=...,
    webex_meeting_callback=...,
)

print(response)