Generate a new Video Room Token

POST 
https://YOUR_SPACE.signalwire.com/api/video/room_tokens

Generate a Room Token allowing a client to join a Room.

Permissions

The API token must include the following scopes: Video.

Request

Responses

200

OK

422

Unprocessable Entity. You may have specified invalid parameters.

Authorization: http

name: basic_authtype: httpscheme: basic

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://YOUR_SPACE.signalwire.com/api/video

Auth

Project ID

API Token

Body required

{
  "room_name": "my_room",
  "user_name": "John Smith",
  "permissions": [
    "room.self.audio_mute",
    "room.self.audio_unmute",
    "room.self.video_mute",
    "room.self.video_unmute",
    "room.self.deaf",
    "room.self.undeaf",
    "room.self.set_input_volume",
    "room.self.set_output_volume",
    "room.self.set_input_sensitivity"
  ],
  "join_from": "2024-07-29T15:51:28.071Z",
  "join_until": "2024-07-29T15:51:28.071Z",
  "remove_at": "2024-07-29T15:51:28.071Z",
  "remove_after_seconds_elapsed": 900,
  "join_audio_muted": false,
  "join_video_muted": false,
  "auto_create_room": false,
  "enable_room_previews": true,
  "room_display_name": "My Room",
  "end_room_session_on_leave": false,
  "join_as": "member",
  "media_allowed": "video-only",
  "room_meta": {
    "key": "value"
  },
  "meta": {
    "key": "value"
  },
  "audio_video_sync": true
}

ResponseClear

Click the Send API Request button above and see the response here!