GET parameters

GET Parameters Overview

The GET parameters for our chat application consist of both obligatory and optional parameters. These parameters allow for customization of the chat interface, user identification, room identification, language selection, interface mode, and more. For specific functions such as audio streaming, there are additional parameters available.

Required Parameters

These parameters are required for the chatroom to function properly:

Parameter	Type	Required	Description
`userId`	string	Yes	A unique identifier for the user in the partner's app. This can be an encrypted ID. The ID must be no longer than 255 characters, and can consist of Latin, Cyrillic, or special characters. No restrictions are set on the character types that can be used.
`roomid`	string	Yes	A unique identifier for the chatroom in the partner's app. This ID must be no longer than 255 characters, and can consist of Latin, Cyrillic, or special characters. No restrictions are set on the character types that can be used.
`apikey`	string	Yes	API key which you can obtain from Watchers manager

Optional Parameters

Parameter	Type	Required	Enabled by Admin Panel	Description
`lang`	string	No	No	An optional language setting for the interface. This parameter can be used to set a default language for the chat interface. Supported languages adhere to ISO 639-1 language codes. More on ISO Language Codes. Supported languages: English (en), Serbian (sr), Armenian (hy), French (fr), Finnish (fi), Russian (ru), Spanish (es), German (de), Arabic (ar), Turkish (tr), Hindi (hi), Romanian (ro), Portuguese (pt), Chinese (zh), Malay (ms), Thai (th), Korean (ko), Icelandic (is), Polish (pl), Ukrainian (uk), Uzbek (uz), Azerbaijani (az), Japanese (ja), Bengali (bn)
`title`	string	No	No	An optional title for the chat room, displayed in the admin panel for easier navigation by moderators. Limited to 255 characters, with no restrictions on character types (Latin, Cyrillic, or special characters).
`mode`	string	No	No	An optional interface mode setting. Options include "dark" for dark mode and "light" for light mode. This parameter sets a default mode for the chat interface, with the ability for users to change it if enabled.
`readonly`	boolean	No	No	When set to true, this optional mode disables all interface controls except the arrow button for navigating to the latest messages. Users can only read messages without interacting with the chat. Useful for public broadcasts, archiving, and moderation. If `readonly` is true, you can provide `userid=0` or use an iframe without the `userid` GET parameter.
`authcode`	string	No	Yes	Must be provided if OAUTH authorization is enabled.
`imageId`	string	No	Yes	See additional information below.
`image`	string	No	Yes	See additional information below.
`nickname`	string	No	Yes	See additional information below.
`os`	string	No	Yes	See additional information below.
`osVersion`	string	No	Yes	See additional information below.

Integration of Partner-Sourced User Properties (Avatars/Names)

This document details how partners can integrate existing user properties—specifically, names and avatars—into our platform through GET parameters.

This approach facilitates the efficient transfer of established user identities from the partner's system to ours, ensuring a consistent and personalized user experience.

Integrating Avatars Through GET Parameters

Partners can choose from two methods to integrate user avatar information via GET parameters:

Image ID Method: Utilize the imageId GET parameter to supply a unique identifier corresponding to each user's avatar image within your application. This identifier enables our system to fetch the user's avatar image directly from your backend.
To facilitate this, partners are required to provide a URL to their backend that hosts the avatar image database. For instance, the URL could follow this format: https://api-gw.example.com/social/file/v1/cache/profile/avatar/[picId]?size=small, where [picId] should be replaced with the unique imageId of the user's avatar.
Direct Image URL Method: Use an image GET parameter to supply a direct URL to the image that will represent the user's avatar on our platform. The format should follow: https://url_to_img.

Select the integration method that aligns with your operational preferences and adjust the corresponding setting in the Admin Panel under Settings > Functional Settings.

Integration of Names via GET Parameters

To integrate user names, utilize the following GET parameter:

Nickname: Employ a nickname GET parameter to pass the user's nickname as it is recognized within your system. This nickname should not exceed 255 characters and may include Latin, Cyrillic, or special characters, with no restrictions on character types.

Admin Panel Adjustments for User Identity Consistency

After selecting your avatar integration method and configuring the setting for user nicknames, please adjust the following settings in the Admin Panel to ensure consistency in the presentation of user identities:

Navigate to Admin Panel > Settings > Appearance.
Disable the following options:
- Name/Avatar Change: Once disabled, this setting prevents users from changing their names and avatars within the chat settings, thus safeguarding the integrity of the integrated user properties.
- Onboarding: This option turns off the ability for users to set their name and avatar during their initial session, thereby preserving the pre-established user identities from the partner system.

By adhering to these integration protocols, partners can efficiently incorporate existing user properties into our platform via GET parameters, facilitating a user experience that is both personalized and coherent.