v2

latestOpenAPI 3.0.0AGPLv32026-07-26125148364.7 KB
Voice

Join Call

Asks the voice server for a token to join the call.

post/channels/{target}/join_call

Path parameters

targetstring required

Request body

nodestring nullable

Name of the node to join

force_disconnectboolean nullable

Whether to force disconnect any other existing voice connections

Useful for disconnecting on another device and joining on a new.

recipientsstring[] nullable

Users which should be notified of the call starting

Only used when the user is the first one connected.

Response

tokenstring required

Token for authenticating with the voice server

urlstring required

Url of the livekit server to connect to