You can create unique video chat rooms when including a custom id parameter in the embed code of a Video Chat Space. Dynamic rooms also accept a NAME parameter.

Dynamic Rooms is best used when you want to designate unique chat rooms for groups of users in your web experiences.

For example, you might embed a chat space on a specific page of your web site or web app using the Button Embed type. And users who visit those pages and join the chat will be in the same room. It could look something like this: 

<script crossorigin="anonymous" async src="https://api.zipcan.com/script.js?token=8rhfld902j&id=CHAT123&name=User%20Name"></script>You'll noticed the id parameter with the value of CHAT123 is included in the src URL of the embed code. In this case, CHAT123 is the room ID, and anyone with access to this embedded chat space will join the same chat.

By simply taking the same code with the same token, and embedding it elsewhere, you can allow users to join the same chat room on different pages of your site, as long as the id parameter is the same. If you change the id to something else, users with access will join a different chat room.

Remember, the id can be whatever you choose. This is also handy if you want to create rooms dynamically based on properties in your site or application.

Likewise, if you do not include a Dynamic Room id, then users will either all join into the same room. Or, depending on if you have User-hosted Chats enabled, the first person to join the chat will start their own unique room.

Name Parameter

You can also include a name parameter, however the name parameter is optional. Any value included here will populate the "Name" field in the lobby before joining the chat.

Remember to use %20 to denote a space in the name if passing a custom name into the embed URL.

Embed Types

You can use Dynamic Rooms with all embed types Zipcan offers, including Button Embed, Inline, and Advanced.

The Inline Embed method uses the same method to generate Dynamic Rooms.

However, since Advanced Embed method uses a web component, to generate a Dynamic Room you must use the id and name attributes in the web component. See Advanced Embed for information on these options.