Live calls

Join a live call that is already running in a chatroom.

Joins a call that is already running, and returns a joining pass for the person making the request. Someone who is already in the call gets a fresh pass instead of appearing twice. Counts against your monthly allowance.

post/v1/join_call_session

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/join_call_session
  • Auth: API key in header X-Partner-Key

Request body

preferred_languagestring nullable

BCP-47-ish language code (e.g. 'en', 'zh-cn') for localized messages.

usernamestring nullable

The end-user's username.

passwordstring nullable

The end-user's password on first sign-in. After login/register, send the returned session token (JWT) here instead — the field accepts either, and reusing the token keeps raw passwords out of your storage.

call_session_idstring nullable

Response

Result envelope — check the success field.

successboolean

Whether the call succeeded.

error_messagestring nullable

Human-readable reason when success is false.

error_codestring
call_session_idstring nullable
auth_tokenstring nullable
participant_idstring nullable
expires_atinteger nullable

UNIX timestamp when this resource or capability expires.

is_hostboolean nullable
call_sessionobject nullable

The call you are now in. Carries call_session_id, the mode and media_tier it is actually running in — which is what you got, not necessarily what you asked for when a call was already going — and who is in it.

Changes

No recorded changes to this operation across all 2 revisions of this API.