GroupVoiceXmlModifyInstanceRequest
Bases: OCIRequest
Request to modify a VoiceXML instance. For a valid voiceXml instance to work properly, a device with Static Registration is expected with a valid contact. 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_user_id (str):
service_instance_profile (Optional[ServiceInstanceModifyProfile]):
network_class_of_service (Optional[str]):
access_device_endpoint (Optional[Nillable[AccessDeviceEndpointModify]]):
webex_meeting_callback (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
| @dataclass(kw_only=True)
class GroupVoiceXmlModifyInstanceRequest(OCIRequest):
"""Request to modify a VoiceXML instance. For a valid voiceXml instance to work properly,
a device with Static Registration is expected with a valid contact.
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_user_id (str):
service_instance_profile (Optional[ServiceInstanceModifyProfile]):
network_class_of_service (Optional[str]):
access_device_endpoint (Optional[Nillable[AccessDeviceEndpointModify]]):
webex_meeting_callback (Optional[bool]):
"""
service_user_id: str = field(metadata={"alias": "serviceUserId"})
service_instance_profile: Optional[ServiceInstanceModifyProfile] = field(
default=None, metadata={"alias": "serviceInstanceProfile"}
)
network_class_of_service: Optional[str] = field(
default=None, metadata={"alias": "networkClassOfService"}
)
access_device_endpoint: Optional[Nillable[AccessDeviceEndpointModify]] = field(
default=None, metadata={"alias": "accessDeviceEndpoint"}
)
webex_meeting_callback: Optional[bool] = field(
default=None, metadata={"alias": "webexMeetingCallback"}
)
def __post_init__(self):
nillable_fields = ["access_device_endpoint"]
for field_name in nillable_fields:
value = getattr(self, field_name)
if value == "" or value == "None":
object.__setattr__(self, field_name, OCINil)
|
Responses
Bases: OCIResponseSource code in src/mercury_ocip/commands/base_command.py
| class SuccessResponse(OCIResponse):
pass
|
Bases: OCIResponseSource 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 GroupVoiceXmlModifyInstanceRequest
client = Client()
command = GroupVoiceXmlModifyInstanceRequest(
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.client import Client
client = Client()
response = client.raw_command("GroupVoiceXmlModifyInstanceRequest",
service_user_id=...,
service_instance_profile=...,
network_class_of_service=...,
access_device_endpoint=...,
webex_meeting_callback=...,
)
print(response)