Skip to content

GroupCollaborateBridgeConsolidatedAddInstanceRequest

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. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise.

The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

add_phone_number_to_group (Optional[bool]):

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 (Optional[List[ConsolidatedUserServiceAssignment]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupCollaborateBridgeConsolidatedAddInstanceRequest(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.
        If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true,
        it will be added to group if the command is executed by a service provider administrator or above
        and the number is already assigned to the service provider. The command will fail otherwise.

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        add_phone_number_to_group (Optional[bool]):

        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 (Optional[List[ConsolidatedUserServiceAssignment]]):

    """

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

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

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

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

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

    service: Optional[List[ConsolidatedUserServiceAssignment]] = field(
        default=None, metadata={"alias": "service"}
    )

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 GroupCollaborateBridgeConsolidatedAddInstanceRequest

client = Client()

command = GroupCollaborateBridgeConsolidatedAddInstanceRequest(
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    add_phone_number_to_group=...,
    service_instance_profile=...,
    maximum_bridge_participants=...,
    network_class_of_service=...,
    max_collaborate_room_participants=...,
    support_outdial=...,
    collaborate_owner_user_id=...,
    service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

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

print(response)