You can also view

You are viewing documentation for version 14. This is the most recent stable release!

Documentation

Intro

Overview New in V14

Apps

Overview Configuration

Overview Browser Support Embedding Configuration Custom Interface JS Methods JS Events Collecting Videos

<room>

Overview Browser Support Embedding Configuration Custom Interface JS Methods JS Events

Overview Embedding Configuration JS Methods & Events

<wall>

Overview Embedding Configuration JS Methods

Overview Embedding Configuration Custom Interface JS Methods JS Events

<photo>

Overview Embedding

Overview Embedding Configuration Custom Interface JS Methods JS Events Collecting Audio

REST API

Overview List Assets Show Asset Update Asset Delete Asset List Apps Show App Create App Update App Video Object Photo Object Audio Object List Rooms Create Room Show Room Update Room Delete Room

Update Room

You can use the REST API to update the start time or end time of existing Rooms programatically.

Request

PUT https://www.cameratag.com/api/v14/apps/[YOUR_APP_UUID]/rooms/[YOUR_ROOM_UUID].json

Parameters

Below is a list of parameters that this endpoint accepts.

Parameter	Accepted Values	Description	Required
api_key	a valid user api_key	All App endpoints require authentcation	Required
start_time	Integer (Unix epoch)	The time that the room should become available to users	optional
end_time	Integer (Unix epoch)	The time that the room should close (and disconnect users)	optional

Example Response

{
  "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
  "name": "Interview room 1",
  "uuid": "0663ac2eadcd95fc4af3139d14324b2987357df56c59adfb88ead98b054fc5bc",
  "start_time": "2020-12-16T03:12:27.316Z",
  "end_time": "2020-12-17T03:12:34.280Z",
  "composited_at": null,
  "state": "closed"
}