Skip to content

Rooms API

Rooms

The room resource that the visitor can access has the following attributes.

Attribute Type Description
id UUID The unique identifier of this room
display_name string Name of the room
language_code string Language of this room in ISO 639-1 code, or null if undefined.
is_online boolean Are there any users online in this room that the the visitor can chat with
brand object The brand used in this room as an object. Contains almost same attributes as in HTTP API section without organization specific information. null if default.

Retrieve room details

Get a single room object by its ID. This may be a shared room.

GET https://service.giosg.com/api/v5/public/orgs/<organization_id>/rooms/<room_id>

Retrieve room's brand details

Get a single room brand object used in room by room's ID. This may be a shared room.

GET https://service.giosg.com/api/v5/public/orgs/<organization_id>/rooms/<room_id>/brand

Returns 404 if the organization has not defined brand for the room.

Online users in a Room

Visitors can fetch a collection of online users in a room

Attribute Type Description
id UUID Unique identifier
public_name string The name of the user as it would be displayed for the visitor. This is user's alias if they have one, otherwise it is their real name.
avatar object The avatar of the user as an object. It contains attributes idand url. This is null if the user has no avatar.

Retrieve a list of online users in a room

GET https://service.giosg.com/api/v5/public/orgs/<organization_id>/rooms/<room_id>/online_users