How do rooms appear on your platform
How to do mapping between your users, events, and chats
The room is integrated into the Partner iOS and Android apps via WebView or iFrame for Web Apps.
A chat room is generated when the request is sent with the parameters transmitted. When the first user logs in, the partner passes the event ID using the GET parameter in the link that opens the Webview.
To allow the room to be shown on the platform, you need to find the place for it and develop the front-end side of your platform.
Rooms can be integrated differently: as a general room, as various rooms for various events. The place for them should be provided on your side.**
Then, when a chat and chat button is placed, you must transfer to us a roomID. This roomId is passed to us whenever your system (frontend) requests to open a chat (when a user clicks the Open chat button). On our side, a new chat room is created every time we receive a new roomID.
On your end, you can implement a mechanism to manage which room should be opened based on the type of game or the title available on the platform.
For example:
All football games can direct users to one chat room with roomId=football.
All TV shows can be linked to one chat room with roomID=tvshow.
Separate titles or games can direct users to a specific chat on a specific page. To ensure seamless integration and alignment with your existing systems, we recommend using your internal event identification system as the roomId.
For example, instead of roomId=specific-title or roomId=specific-football-game, use identifiers like roomId=event12345 or roomId=game_56789.
This approach simplifies mapping and improves compatibility between your platform and the chat functionality.
To allow users to enter this chat room, you need to send us not only a roomID but also a userID. Usually, they are the same with IDs you operate on your platform or their encrypted variants.
When you transfer both parameters, this particular user can enter this particular chatroom.
You can also transfer additional parameters:
- Title (it does not affect users but helps you work with rooms through the admin panel)
- Platform (app, mobile web, or desktop to optimise the interface and specify analytics)
- Lang (the language that the user selects to use your platform; if you don’t transfer it, the default language will be set; the default language for the chat is selected on the admin panel)
- Mode (light or dark mode depends on the mode this user uses right now; if you don’t transfer it, the default mode will be set; the default mode for the chat is selected on the admin panel).
See the example of the link you need to use for the chat on your front-end:
When you do your parts on your front end, you can use the Watchers back office to customise the chat: colours, fonts, icons, and interface elements. Yet, it can be done just after placing the chat on your interface with your front-end developers with your exclusive API key.
Additional: Scheduled rooms
Before scheduling the room, make sure that you find the place where this scheduled room will appear and that your front-end developers have already added a specific button for chat opening. It can be a part of your platform’s interface or a separate page. After doing so, you can schedule a room for a particular time.
When users click on a chat button, they will see a countdown. You can customise all the text in the window with a countdown through the Watchers’ admin panel. You can manage this room and add live audio or video streaming there.
Updated 2 months ago