Calls

Private and group voice/video calling (WebSocket version only)

📄️ Start private call

Initiates a private 1-on-1 voice or video call. Can auto-create a conversation thread if thread_id is 0 or not provided. Only works for conversations with exactly 2 participants. The user must have reply permission in the conversation. Returns a room token and encryption key for establishing the call connection. Fires the `better_messages_call_created` action hook. Requires WebSocket version.

📄️ Create call room

Creates a call message in a conversation and generates a room token. Used for multi-participant conversations. The call message is stored with `bpbm_call` metadata. Returns tokens and participant data needed to establish the call. Requires WebSocket version.

📄️ Join call

Joins an existing active call session. The message must have `bpbm_call` metadata indicating an active call. Returns a room token and encryption key for the user to connect. The user must be a participant of the conversation. Requires WebSocket version.

📄️ Start group call

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.

📄️ Moderate group call

Runs a moderator action in a group call, chosen with `act`. Moderators of the conversation may use every action, everyone else only `raise_hand` and `lower_own_hand`. Participants are named by their call identity, `user_` and the user ID (`user_-5` for a guest). Requires WebSocket version.