PlaceModifyRequest

Bases: OCIRequest

Request to configure a WebEx room/place to have the primary endpoint of WebEx Teams device.

placeUserId refers to a WebEx room/place.
webExSIPAddress specifies the WebEx SIP address of the place. The format of this parameter is: user@domain.
The user part specified in webExSIPAddress will be set to the lineport of the place’s primary endpoint. The endpoint
will have a static address with URI set to "sip:user@domain".
The domain specified in webExSIPAddress will be:
- added to the system if it does not exist yet.
- assigned to the service provider/enterprise which the place belongs to, if it has not been assigned yet.
- assigned to the group which the place belongs to, if it has not been assigned yet.

The response is either SuccessResponse or ErrorResponse.

Attributes:

place_user_id (str):

web_ex_sip_address (Optional[str]):

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

@dataclass(kw_only=True)
class PlaceModifyRequest(OCIRequest):
    """Request to configure a WebEx room/place to have the primary endpoint of WebEx Teams device.

        placeUserId refers to a WebEx room/place.
        webExSIPAddress specifies the WebEx SIP address of the place. The format of this parameter is: user@domain.
        The user part specified in webExSIPAddress will be set to the lineport of the place’s primary endpoint. The endpoint
        will have a static address with URI set to \"sip:user@domain\".
        The domain specified in webExSIPAddress will be:
        - added to the system if it does not exist yet.
        - assigned to the service provider/enterprise which the place belongs to, if it has not been assigned yet.
        - assigned to the group which the place belongs to, if it has not been assigned yet.

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        place_user_id (str):

        web_ex_sip_address (Optional[str]):

    """

    place_user_id: str = field(metadata={"alias": "placeUserId"})

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

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 PlaceModifyRequest

client = Client()

command = PlaceModifyRequest(
    place_user_id=...,
    web_ex_sip_address=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("PlaceModifyRequest",
    place_user_id=...,
    web_ex_sip_address=...,
)

print(response)