API Room Status

This API provides the current status for a specified room.

Resource URL

http://valt.example.com/api/v3/rooms/{roomid}/status

Replace {roomid} with the actual id number of the room. Rooms are numbered sequentially when added to VALT.

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized
404	Room ID Not Found

JSON Response

data
status	Current Room Status Status Description available Room is available and recording can be started. recording Room is currently recording. paused Room is currently recording, but the recording is paused. prepared Room has been prepared, but the recording has not been initiated. locked Room has been locked, recording cannot be started until unlocked.
record	true = room is currently recording, false = room is not recording
record_id	ID number for the active recording (will only return if record = true.)
record_access	true = current authenticated user has access to the recording, false = current authenticated users does not have access to the recording (will only return if record = true.)

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/rooms/37/status?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"status": "available",
"record": false
}
}

Failure Response

{"error":{"code":401,"message":"No API key provided"}}