This is a tiny wrapper around Whereby's HTTP API.
$ pip install whereby_api
api_key
– the API key you received from Whereby (string)
from whereby_api import WherebyClient
whereby = WherebyClient(api_key='<your api key>')
-
create_meeting(start_date, end_date, is_locked=False, room_name_prefix=None, room_mode='normal', fields=[])
Create a new meeting
start_date
– When the meeting starts (required, either adatetime
object or an ISO 8601 string)end_date
– When the meeting ends (required, either adatetime
object or an ISO 8601 string)is_locked
– The initial lock state of the room (boolean)room_name_prefix
– The prefix for the room name. (string)room_mode
– The mode of the created room. (string –normal
orgroup
)fields
– Additional fields that should be populated. (list of strings, currently the only option is'hostRoomUrl'
)
Please refer to the official documentation for details.
whereby_api.Meeting
instancefrom datetime import datetime, timedelta meeting = whereby.create_meeting( start_date=datetime.now(), end_date=datetime.now() + timedelta(days=2), fields=['hostRoomUrl'], )
-
Delete an existing meeting
meeting_id
– the ID of the meeting (required, string)
Please refer to the official documentation for details.
whereby.delete_meeting(meeting_id='123456')
-
Get details about an existing meeting
meeting_id
– the ID of the meeting (required, string)
Please refer to the official documentation for details.
whereby_api.Meeting
instancemeeting = whereby.get_meeting(meeting_id='123456')
Represents a meeting
meeting_id
– The ID of the meeting. (string)room_url
– The URL to room where the meeting will be hosted. (string)start_date
– When the meeting starts. (datetime)end_date
– When the meeting ends. (datetime)host_room_url
– The URL to room where the meeting will be hosted which will also make the user the host of the meeting. (string)
Please refer to the official documentation for details.