Skip to content

GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest

Bases: OCIRequest

Modify an existing Virtual On-Net user of a Group. The serviceProviderId, groupId and phoneNumber combination uniquely identifies a Virtual On-Net User. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

phone_number (str):

extension (Optional[str]):

first_name (Optional[str]):

last_name (Optional[str]):

calling_line_id_first_name (Optional[str]):

calling_line_id_last_name (Optional[str]):

virtual_on_net_call_type_name (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest(OCIRequest):
    """Modify an existing Virtual On-Net user of a Group.
        The serviceProviderId, groupId and phoneNumber combination uniquely
        identifies a Virtual On-Net User.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        phone_number (str):

        extension (Optional[str]):

        first_name (Optional[str]):

        last_name (Optional[str]):

        calling_line_id_first_name (Optional[str]):

        calling_line_id_last_name (Optional[str]):

        virtual_on_net_call_type_name (Optional[str]):

    """

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

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

    phone_number: str = field(metadata={"alias": "phoneNumber"})

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

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

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

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

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

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

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 GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest

client = Client()

command = GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest(
    service_provider_id=...,
    group_id=...,
    phone_number=...,
    extension=...,
    first_name=...,
    last_name=...,
    calling_line_id_first_name=...,
    calling_line_id_last_name=...,
    virtual_on_net_call_type_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("GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest",
    service_provider_id=...,
    group_id=...,
    phone_number=...,
    extension=...,
    first_name=...,
    last_name=...,
    calling_line_id_first_name=...,
    calling_line_id_last_name=...,
    virtual_on_net_call_type_name=...,
)

print(response)