Skip to content

UserMeetMeConferencingAddConferenceRequest23

Bases: OCIRequest

Add a Meet-Me conference. The response is either UserMeetMeConferencingAddConferenceResponse23 or ErrorResponse. The startTime element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startTime. The startTime, endTime and recurrence information for a conferenceSchedule element will be adjusted to the user Host time zone.

Attributes:

user_id (str):

bridge_id (str):

title (str):

estimated_participants (Optional[int]):

restrict_participants (Optional[bool]):

max_participants (Optional[int]):

account_code (Optional[str]):

mute_all_attendees_on_entry (bool):

end_conference_on_moderator_exit (bool):

moderator_required (bool):

require_security_pin (bool):

allow_unique_identifier (bool):

attendee_notification (str):

conference_schedule (MeetMeConferencingConferenceSchedule):

allow_participant_unmute_in_auto_lecture_mode (bool):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserMeetMeConferencingAddConferenceRequest23(OCIRequest):
    """Add a Meet-Me conference.
        The response is either UserMeetMeConferencingAddConferenceResponse23 or ErrorResponse.
        The startTime element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startTime.
        The startTime, endTime and recurrence information for a conferenceSchedule element will be adjusted to the user Host time zone.

    Attributes:

        user_id (str):

        bridge_id (str):

        title (str):

        estimated_participants (Optional[int]):

        restrict_participants (Optional[bool]):

        max_participants (Optional[int]):

        account_code (Optional[str]):

        mute_all_attendees_on_entry (bool):

        end_conference_on_moderator_exit (bool):

        moderator_required (bool):

        require_security_pin (bool):

        allow_unique_identifier (bool):

        attendee_notification (str):

        conference_schedule (MeetMeConferencingConferenceSchedule):

        allow_participant_unmute_in_auto_lecture_mode (bool):

    """

    user_id: str = field(metadata={"alias": "userId"})

    bridge_id: str = field(metadata={"alias": "bridgeId"})

    title: str = field(metadata={"alias": "title"})

    estimated_participants: Optional[int] = field(
        default=None, metadata={"alias": "estimatedParticipants"}
    )

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

    max_participants: Optional[int] = field(
        default=None, metadata={"alias": "maxParticipants"}
    )

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

    mute_all_attendees_on_entry: bool = field(
        metadata={"alias": "muteAllAttendeesOnEntry"}
    )

    end_conference_on_moderator_exit: bool = field(
        metadata={"alias": "endConferenceOnModeratorExit"}
    )

    moderator_required: bool = field(metadata={"alias": "moderatorRequired"})

    require_security_pin: bool = field(metadata={"alias": "requireSecurityPin"})

    allow_unique_identifier: bool = field(metadata={"alias": "allowUniqueIdentifier"})

    attendee_notification: str = field(metadata={"alias": "attendeeNotification"})

    conference_schedule: MeetMeConferencingConferenceSchedule = field(
        metadata={"alias": "conferenceSchedule"}
    )

    allow_participant_unmute_in_auto_lecture_mode: bool = field(
        metadata={"alias": "allowParticipantUnmuteInAutoLectureMode"}
    )

Responses

Bases: OCIDataResponse

Response to UserMeetMeConferencingAddConferenceRequest23. Contains the information of a conference.

Attributes:

conference_id (str):

moderator_pin (str):

security_pin (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserMeetMeConferencingAddConferenceResponse23(OCIDataResponse):
    """Response to UserMeetMeConferencingAddConferenceRequest23.
        Contains the information of a conference.

    Attributes:

        conference_id (str):

        moderator_pin (str):

        security_pin (Optional[str]):

    """

    conference_id: str = field(metadata={"alias": "conferenceId"})

    moderator_pin: str = field(metadata={"alias": "moderatorPin"})

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

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 UserMeetMeConferencingAddConferenceRequest23

client = Client()

command = UserMeetMeConferencingAddConferenceRequest23(
    user_id=...,
    bridge_id=...,
    title=...,
    estimated_participants=...,
    restrict_participants=...,
    max_participants=...,
    account_code=...,
    mute_all_attendees_on_entry=...,
    end_conference_on_moderator_exit=...,
    moderator_required=...,
    require_security_pin=...,
    allow_unique_identifier=...,
    attendee_notification=...,
    conference_schedule=...,
    allow_participant_unmute_in_auto_lecture_mode=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserMeetMeConferencingAddConferenceRequest23",
    user_id=...,
    bridge_id=...,
    title=...,
    estimated_participants=...,
    restrict_participants=...,
    max_participants=...,
    account_code=...,
    mute_all_attendees_on_entry=...,
    end_conference_on_moderator_exit=...,
    moderator_required=...,
    require_security_pin=...,
    allow_unique_identifier=...,
    attendee_notification=...,
    conference_schedule=...,
    allow_participant_unmute_in_auto_lecture_mode=...,
)

print(response)