Skip to content

GroupCollaborateBridgeAddInstanceRequest20sp1

Bases: OCIRequest

Add a collaborate bridge to a group. The domain is required in the serviceUserId. The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

service_instance_profile (ServiceInstanceAddProfile):

maximum_bridge_participants (CollaborateBridgeMaximumParticipants):

network_class_of_service (Optional[str]):

max_collaborate_room_participants (int):

support_outdial (bool):

collaborate_owner_user_id (Optional[List[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupCollaborateBridgeAddInstanceRequest20sp1(OCIRequest):
    """Add a collaborate bridge to a group.
        The domain is required in the serviceUserId.
        The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        service_instance_profile (ServiceInstanceAddProfile):

        maximum_bridge_participants (CollaborateBridgeMaximumParticipants):

        network_class_of_service (Optional[str]):

        max_collaborate_room_participants (int):

        support_outdial (bool):

        collaborate_owner_user_id (Optional[List[str]]):

    """

    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"}
    )

    maximum_bridge_participants: CollaborateBridgeMaximumParticipants = field(
        metadata={"alias": "maximumBridgeParticipants"}
    )

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

    max_collaborate_room_participants: int = field(
        metadata={"alias": "maxCollaborateRoomParticipants"}
    )

    support_outdial: bool = field(metadata={"alias": "supportOutdial"})

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

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 GroupCollaborateBridgeAddInstanceRequest20sp1

client = Client()

command = GroupCollaborateBridgeAddInstanceRequest20sp1(
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    maximum_bridge_participants=...,
    network_class_of_service=...,
    max_collaborate_room_participants=...,
    support_outdial=...,
    collaborate_owner_user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupCollaborateBridgeAddInstanceRequest20sp1",
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    maximum_bridge_participants=...,
    network_class_of_service=...,
    max_collaborate_room_participants=...,
    support_outdial=...,
    collaborate_owner_user_id=...,
)

print(response)