Start group call
POST/groupCallStart
Starts or joins a group voice/video call in a thread. The response includes a room token and the current call mode (participatory or broadcast). In broadcast mode, non-moderators receive a receive-only token. Moderators can lock the room, mute participants, and switch between participatory and broadcast modes via the group call admin endpoint (/groupCallAdmin). Requires WebSocket version.
Since 3.2 a person banned from the conversation's calls, or from a chat room, is refused with a 403 that says until when, and the answer also carries canPublish, micMuted, the call's recording and, for moderators, canBanFromChat. A call that cannot take more people is refused with group_call_full. The better_messages_group_call_join_custom_error filter can refuse with a message of its own.
Request#
Responses#
- 200
- 400
- 403
- 502
Group call token and room state, or false when the user may not join and no message says why
The call type is not audio or video (invalid_type)
Refused, with a message: group_call_forbidden (banned from the conversation or its calls, a role not allowed to join, group calls off for the conversation, or a message from the better_messages_group_call_join_custom_error filter), group_call_start_forbidden (the user may not start a call and nobody is in it), room_locked, group_call_full (the call cannot take more people right now) or encryption_unsupported
The call server could not start the call (group_call_unavailable)