Create a meeting

POST https://connect.suryojasvi.com/api/v1/meetings

Make a meeting on the organization's meeting server, and post its card into a conversation -- a channel's topic, or a direct message conversation -- from which anyone in it can join.

The card is a message with a meeting widget, which shows whether the meeting has started and who is in it, as the meeting server reports it. A meeting scheduled for later also gets a reminder in the conversation, sent as its creator 10 minutes before it starts.

Changes: New in Zulip 13.0 (feature level ZF-806fae).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://connect.suryojasvi.com/api/v1/meetings \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'title=Weekly sync' \
    --data-urlencode stream_id=1 \
    --data-urlencode topic=planning \
    --data-urlencode 'user_ids=[10, 11]' \
    --data-urlencode scheduled_start=1791400000 \
    --data-urlencode scheduled_end=1791401800

Parameters

title string optional

Example: "Weekly sync"

The meeting's title, of at most 60 characters. "Meeting" if empty.


stream_id integer optional

Example: 1

The channel to post the meeting into, with topic. Specify this or user_ids.


topic string optional

Example: "planning"

The topic to post the meeting into, with stream_id.


user_ids (integer)[] optional

Example: [10, 11]

The direct message conversation to post the meeting into, by the IDs of the users in it.


scheduled_start integer optional

Example: 1791400000

When the meeting is to start, as a UNIX timestamp in seconds, if it is not to start now.


scheduled_end integer optional

Example: 1791401800

When a scheduled meeting is to end, as a UNIX timestamp in seconds: after scheduled_start, and within 24 hours of it. Only with scheduled_start.

Changes: New in Zulip 13.0 (feature level ZF-35f988).


Response

Return values

  • meeting_id: integer

    The meeting's ID. * message_id: integer

    The ID of the meeting's card. * join_url: string

    Where someone from the organization joins the meeting, signed in.

  • guest_url: string

    The meeting's link for someone outside the organization, who joins as a guest.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "guest_url": "https://meet.example.com/meet-3f2a9c1b7d4e5f60a1b2c3d4",
    "join_url": "/meet/meet-3f2a9c1b7d4e5f60a1b2c3d4",
    "meeting_id": 1,
    "message_id": 45,
    "msg": "",
    "result": "success"
}