Live calls

Check whether a chatroom has a live call, and how many people are in it.

Reports the live call in a chatroom, or null when there is none, along with how many people are in it. Use it when opening a room so somebody arriving late can see a call in progress. A call whose participants have all disappeared without saying so is detected and closed here rather than being reported forever.

post/v1/get_active_call_session

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/get_active_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.

chatroom_idstring nullable

Chatroom id as returned by chatroom operations.

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_sessionobject nullable

The call running in this chatroom, or null when there is none. Reported whether or not you are in it, so a client opening a room can offer the way in; joining is a separate request.

Changes

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