Live calls

Make somebody a co-host of a live call, or stand them down again.

Gives somebody the call controls — muting, removing, and deciding who may speak — for the length of one call, or takes them back. Available to anybody who already has them. The chatroom owner and admins are not affected either way: they hold these controls in every call in their room, so they cannot be given them and, more importantly, cannot be stripped of them by a guest. A change takes effect the next time that person connects to the call, because what somebody is allowed to do is fixed in the joining pass they were issued; ask them to reconnect, or call join_call_session for them again. The appointment lasts as long as the call and does not make anybody an admin of the chatroom.

post/v1/set_call_host

Request

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

User id of the person whose standing in the call is changing.

runs_the_callboolean nullable

True to give that person the call controls for the length of this call; false to take them back.

Response

Result envelope — check the success field.

successboolean

Whether the call succeeded.

error_messagestring nullable

Human-readable reason when success is false.

error_codestring

Changes

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