Generate a new Video Room Token
Generate a Room Token allowing a client to join a Room.
The API token must include the following scopes: Video.
|Request Body — REQUIRED|
Room's unique named identifier. Allowed characters: A-Za-z0-9_-. Up to 100 characters. The room does not have to exist when the token is created, but must exist prior to joining, or ensure auto_create_room is set to true.
A display name to use for the user. Up to 100 characters. (If not supplied, a random alphanumeric string will be returned for each authorization with this token.)
A list of permissions, which define what user can do once they join the room.
The user can't join the room before this time. Expects RFC 3339 datetime:
The user can't join the room after this time. Expects RFC 3339 datetime:
Remove user from the room at this time. Expects RFC 3339 datetime:
Remove user after they are in the room for N seconds.
Whether the user joins the room with their audio muted.
Whether the user joins the room with their video muted.
By default, if the user tries to use this token to join a room that doesn't exist, it will be created with default configuration. Set this to false to require the room to exist beforehand.
Whether to generate a video with a preview of the content of the room. This parameter has effect only if this token auto-creates the room, thus it will be ignored if the room already exists.
Display name used if a room is auto-created when the token joins. Maximum of 200 characters. Defaults to the value of room_name.
Whether to end the room session when the member using this token leaves the room.
Possible values: [
Whether the user should join as a member or as a non-interactive audience participant. Audience participants cannot send audio or video.
Possible values: [
Indicates what media the user is allowed to receive.
Set the room meta.
Set the member meta.
Unprocessable Entity. You may have specified invalid parameters.