User & Guest User

Fetch user details

GET /rooms/<access_key>/users/<user_id> # Fetch user details.
  RESPONSES 200 OK, 404 NOT FOUND, 410 GONE

Example Response

{
  "id": "63ede350b20526000f64376d",
  "name": "Jane Doe",
  "avatar": "https://myawesomeapp.com/images/avatar.png",
  "guest": false,
  "joined_at": "2021-01-01T09:00:00.000Z"
}

Register guest user

Using the guest token received from the room creation, any number of guest users can be created. This provides an option for you to offer a "quick join" method to a meeting.

A guest user only has access to a running meeting session. Once a meeting ends, the guest user cannot join any future meetings in this room.

POST /guests/<guest_token> # Create a guest user for a meeting.
  RESPONSES 201 CREATED, 400 BAD REQUEST, 410 GONE, 423 LOCKED

Parameters	Type	Description
id	String (optional)	User identifier
name	String (required)	Users name to be displayed in participants list.
avatar	String (optional)	HTTP URI to a user avatar.
custom_fields[locale]	Language Code (optional)	User preferred language code (en, de, fr).

Example Response

{
  "access_key": "cnNqsoJlGIsf8L2WtqDzrH4y",
  "ready": false,
  "locked": false,
  "room": {
    "id": "63ede350b20526000f64376b",
    "name": "eyeson room",
    "ready": true,
    "started_at": "2021-01-01T09:00:00.000Z",
    "shutdown": false,
    "sip": {
      ...
    },
    "guest_token": "gKsiVlrvkFyL3klk1wBHLlm3"
  },
  "team": {
    "name": "My Company Ltd."
  },
  "user": {
    "id": "63ede4a773b114000faa26eb",
    "room_id": "63ede350b20526000f64376b",
    "name": "Guest user",
    "avatar": "https://myawesomeapp.com/images/guest-avatar.png",
    "guest": true,
    "ready": false,
    "sip": {
      ...
    }
  },
  "links": {
    "self": "https://api.eyeson.team/rooms/cnNqsoJlGIsf8L2WtqDzrH4y",
    "gui": "https://app.eyeson.team/?cnNqsoJlGIsf8L2WtqDzrH4y",
    "guest_join": "https://app.eyeson.team/?guest=gKsiVlrvkFyL3klk1wBHLlm3",
    "websocket": "https://api.eyeson.team/rt?access_key=cnNqsoJlGIsf8L2WtqDzrH4y"
  },
  "options": {
    "show_names": true,
    "show_label": true,
    "exit_url": null,
    "recording_available": true,
    "broadcast_available": true,
    "layout_available": true,
    "layout": "auto",
    "reaction_available": true,
    "suggest_guest_names": true,
    "lock_available": false,
    "kick_available": true,
    "sfu_mode": "ptp",
    "layout_users": null,
    "layout_map": null,
    "layout_name": null,
    "voice_activation": false,
    "custom_fields": {},
    "widescreen": false
  },
  "presentation": null,
  "broadcasts": [],
  "recording": null,
  "snapshots": [],
  "signaling": {
    ...
  }
}