Room

<- Voltar ao menu

Room

Room

An room is virtual place to communicate in an org.

Attributes

Name	Type	Description	Example
avatar_image	nullable string	an avatar image of the room	null
background_image	nullable string	a background image of the room	null
id	integer	unique identifier of the room	42
online_members	nullable array	the list of users that are online in the specific room	null
org_id	integer	the id of the org that the rooms belongs to	42
subtitle	nullable string	the subtitle of the room	null
title	string	the title of the room	"example"
token	nullable string	a token of the room used for audio and video calls	null

Room Create

Create a new room

POST /room

Optional Parameters

Name	Type	Description	Example
avatar_image	nullable string	an avatar image of the room	null
background_image	nullable string	a background image of the room	null
id	integer	unique identifier of the room	42
org_id	integer	the id of the org that the rooms belongs to	42
subtitle	nullable string	the subtitle of the room	null
title	string	the title of the room	"example"

Curl Example

$ curl -n -X POST https://production-room-api.herokuapp.com/room \
  -d '{
  "id": 42,
  "org_id": 42,
  "title": "example",
  "subtitle": null,
  "background_image": null,
  "avatar_image": null
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 201 Created

null

Room Room access

It updates the current room that the user is in

PUT /room_access

Optional Parameters

Name	Type	Description	Example
id	integer	unique identifier of the room	42

Curl Example

$ curl -n -X PUT https://production-room-api.herokuapp.com/room_access \
  -d '{
  "id": 42
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

null