Room Code Authentication

Room Codes are 100ms generated short codes, representing a Room ID and Role combination. Room codes not only simpify authentication, they can also be used to generate Room Links.

Room Code Authentication Basics

When using Room Codes, it eliminates the need to generate auth token at your end to join a room. - If you're using 100ms Prebuilt solution, Prebuilt inherently takes care of generating the auth token using room codes. - When building a custom UI, you need to make an additional SDK API call getAuthTokenByRoomCode to generate the auth token.

Join rooms with room codes for custom UI

When building a custom UI and using room codes to generate room links, you can also use room codes to power authentication to join room without setting up an auth token server at your end.

Create Room Codes

Room codes can be made available in two ways:

For Rooms created on 100ms dashboard, a room code gets generated for every role in the room by default.

RoomCodeFromJoinRoomModal

Retrieve role specific room code

No-Code
- Select a room from Room page on 100ms Dashboard and click on "Join Room"
- Copy room code for the role you want to authenticate

RoomCodeFromJoinRoomModal

Programmatically,
- From the Room Link that you generate. For instance, you can retrieve room code from a custom room link https://<your-template-subdomain>.app.100ms.live/meeting/<room-code>
- Alternatively, you can use Get Room Code API to retrieve the room code for the role joining the room.

Get auth token using room codes

Once you have a role specific room code, call the SDK function getAuthTokenByRoomCode with the retrieved room code. This function retrieves the auth token that is required to join the room.

Sample Code

You can use these code snippets to get auth token from room code.


const authToken = await hmsActions.getAuthTokenByRoomCode({ roomCode });

try {
    await hmsActions.join({ userName, authToken });
} catch (e) {
    console.error(e);
}


try {
    /**
     * Important Note: Don't build new `HMSSDK` instance before destroying the previous one.
     * for more info checkout {@link https://www.100ms.live/docs/react-native/v2/how--to-guides/install-the-sdk/hmssdk#what-does-destroy-method-do}
     */
    const hmsInstance = await HMSSDK.build();

    // Saving `hmsInstance` in ref
    hmsInstanceRef.current = hmsInstance;

    /**
     * `getAuthTokenByRoomCode` returns a promise which is resolved with "auth token"
     * checkout {@link https://www.100ms.live/docs/react-native/v2/how--to-guides/install-the-sdk/hmssdk#what-does-destroy-method-do}
     */
    const token = await hmsInstance.getAuthTokenByRoomCode('YOUR_ROOM_CODE');

    // ... Adding HMSSDK Event Listeners before calling Join method on HMSSDK instance ...

    /**
     * Create `HMSConfig` with the above auth token and username
     */
    const hmsConfig = new HMSConfig({ authToken: token, username: USERNAME });

    /**
     * Joining Room. For more info, Check out {@link https://www.100ms.live/docs/react-native/v2/features/join#join-a-room | Join a Room}
     */
    hmsInstance.join(hmsConfig);
} catch (error) {
    // Handle errors here
}


func generateToken() {
   val hmsInstance = HMSSDK
    .Builder(application)
    .build()

   hmsInstance.getAuthTokenByRoomCode(TokenRequest(#room-code, #user-id), null , object :
      HMSTokenListener {
      override fun onError(error: HMSException) {}

      override fun onTokenSuccess(string: String) {
        //here's the token !
      }

    })
}


func joinRoom() {
    hmsSDK.getAuthTokenByRoomCode("room-code") { token, error in
        if let token = token {
            let config = HMSConfig(userName: "John Doe", authToken: token)
            hmsSDK.join(config: config, delegate: self)
        }
    }
}
override func viewDidLoad() {
    super.viewDidLoad()
    joinRoom()
}


  dynamic authToken = await hmsSDK.getAuthTokenByRoomCode(roomCode: 'YOUR_ROOM_CODE');

  if(authToken is String){
    HMSConfig roomConfig = HMSConfig(
        authToken: authToken,
        userName: userName,
      );

    hmsSDK.join(config: roomConfig);
  }
  else if(authToken is HMSException){
    // Handle the error
  }

Quickstart with room code authentication

Overview Room Links

Have a suggestion? Recommend changes ->