Share Video Conference Chat

Prev Next
Post
/api/v1/video-conference.share-chat

Gives the conference members who cannot read the call chat access to it, and returns the ID of the room that holds the chat afterwards. If every member already has access, the current chat room ID is returned and nothing changes. When the selected mode is not allowed, the request fails with error-not-allowed.

You must be a member of the conference or have access to the conference's room or discussion. Requests are limited to 5 per minute per client IP address.

Changelog

Version Description
8.9.0 Added
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example
{
  "callId": "697887e3c8b0533020781a4a",
  "mode": "discussion"
}
object
callId
string Required

The video conference call ID.

Example697887e3c8b0533020781a4a
mode
string Required

How to give members access to the call chat:

  • invite: Add the members without access to the room that holds the chat. Not available for rooms that cannot take new members, such as direct messages.
  • discussion: Move the chat to a new discussion that includes the conference members. Requires discussions to be enabled and the start-discussion or start-discussion-other-user permission.
Valid values[ "invite", "discussion" ]
Examplediscussion
Responses
200

OK

Success Example
{
  "rid": "7Tb3XkPq9WmRzL2cN",
  "success": true
}
object
rid
string

The ID of the room that holds the call chat.

success
boolean
400

Bad Request

Missing Parameter
{
  "success": false,
  "error": "must have required property 'callId' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
404

Not Found. The call does not exist, or you are neither a member of the conference nor able to access its room.

Not Found
{
  "success": false,
  "error": "Resource not found"
}
object
success
boolean
error
string