Room Links

A Room Link is a link that a peer can use to join a room. It is always associated to a specific room and role, allowing unique room links for each role in a room.

Room Links Basics

In order to construct unique room links for each role in your room, you need

  • a domain to host the sample web app
    • use 100ms hosted template-subdomain when using Prebuilt room links
    • self-hosted your-domain when customising and deploying our sample web apps.
  • a role specific room code. For instance,
    • host : abc-perj-xno
    • guest : jnj-owef-kjs

If you're using 100ms Prebuilt solution, the room link looks like : https://<template-subdomain>/meeting/<room-code>

  1. template-subdomain : This the subdomain that you’ve defined at the time of template creation on 100ms dashboard.
  2. room-code : This belongs to a unique room_id and role for which you're creating the room link

Head over to Construct a Prebuilt Room Link for details.

Query parameters

Prebuilt links on the 100ms domain support the following query parameters:

  • name: If the name key is specified, the input field in preview is locked and the peer will not have the option to change their name.

  • userId: The userId key is case-sensitive and can be used to uniquely identify a peer.

If you're using 100ms sample apps or building from scratch, you'd need to construct a custom Room Link to embed or share it with your users. A custom domain Room Link looks like https://<your-domain>/<room-code>

  1. your-domain : This allows you to define a customised Room Link
  2. room-code : This belongs to a unique room_id and role for which you're creating the Room Link
  1. Create a Template, Room and at least one Role
  2. Use Create Room Code to generate room codes for one or more roles in a room
  3. Retrieve Room Codes for each role in the room.
  4. Construct your custom domain room link by appending the retrieved room code to the URL format for each role in the room.

Make sure to use only enabled room codes to create room links. Read about Room Code Basics


Have a suggestion? Recommend changes ->

Was this helpful?

1234