API Recording Details
This API provides details for a specified recording.
Contents
Resource URL
http://valt.example.com/api/v3/records/{recordingid}
Replace {recordingid} with the actual id number of the recording. Recordings 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 | Recording ID Not Found |
| data | |||
|---|---|---|---|
| id | Recording ID Number | ||
| name | Recording Name | ||
| template | Array of additional information template fields. | ||
| created | Date/Time Recording Was Created (Epoch Time) | ||
| author | Creator or current owner of the video. | ||
| id | User ID for Author | ||
| name | Username for Author | ||
| type | should always be "record" | ||
| duration | Recording Duration | ||
| room | Room in which the video was recorded. | ||
| id | Room ID | ||
| name | Room Name | ||
| cameras | Cameras included in recording. | ||
| {cameraid} | Camera Name | ||
| Sharing | |||
| groups | Array of group IDs the video is shared with in addition to default video permissions. | ||
| users | Array of user IDs the video is shared with in addition to default video permissions. | ||
| retention | Video retention settings. | ||
| type | Retention Type (inherit,infinitely,until,for) | ||
| until | Date videos will be retained until. If another retention type is set, will not return. | ||
| days | Number of days a video will be retained for. If another retention type is set, will not return. | ||
| hours | Number of hours a video will be retained for. If another retention type is set, will not return. | ||
| minutes | Number of minutes a video will be retained for. If another retention type is set, will not return. | ||
| markers | Array of markers. (Will return an empty array if there are no markers in the video.) | ||
| id | Marker ID | ||
| event | Marker Name | ||
| time | Time index in seconds where the marker is located in the video. | ||
| color | Marker Color | ||
| hex color | Hex code for the specified color. | ||
| template | Array of additional marker template fields. | ||
| videos | Array of all videos included in the record (one video for each camera utilized). | ||
| url | URL to pull video stream from Wowza | ||
| id | Camera ID | ||
| name | Camera Name | ||
| data | ||||
|---|---|---|---|---|
| id | Recording ID | |||
| name | Recording Name | |||
| template | Array of additional information template fields. | |||
| created | Date/Time Recording Was Created (Epoch Time) | |||
| author | Creator or current owner of the video. | |||
| id | User ID for Author | |||
| name | Username for Author | |||
| type | Type of object (should always be "record") | |||
| duration | Recording Duration (in seconds) | |||
| room | Room in which the video was recorded | |||
| id | Room ID | |||
| name | Room Name | |||
| cameras | Cameras included in recording | |||
| {cameraid} | Camera Name | |||
| sharing | ||||
| users | Array of user IDs the recording is shared with in addition to default video permissions. | |||
| groups | Array of group IDs the recording is shared with in addition to default video permissions. | |||
| retention | Recording retention settings. | |||
| type | Retention type (inherit, infinitely, until, for) | |||
| until | Retention expiration date (if type is "until") | |||
| days | Retention duration in days (if type is "for") | |||
| hours | Retention duration in hours (if type is "for") | |||
| minutes | Retention duration in minutes (if type is "for") | |||
| comments | Array of user comments associated with the video | |||
| id | Comment ID | |||
| message | Comment message content | |||
| recordTime | Time (in seconds) comment is anchored to | |||
| color | Color associated with comment | |||
| createdAt | Timestamp when comment was created | |||
| updatedAt | Timestamp when comment was last updated | |||
| updatedBy | User ID of who performed last update to this comment | |||
| templateId | Template ID if comment is tied to one | |||
| author | ||||
| id | Author ID | |||
| username | Author's login name | |||
| displayName | Author's display name | |||
| group | Author's group ID and additional group-related data | |||
| videos | Array of camera video entries | |||
| id | Video ID | |||
| name | Camera name | |||
| type | Device Type (camera/stream) | |||
| status | ||||
| type | Video Status Type (ready/created) | |||
| duration | Duration of the video in seconds | |||
| rotation | Rotation setting for video | |||
| hasAudio | Boolean indicating if audio is present | |||
| ordinal | Order index of the camera feed | |||
| sources | Array of stream URLs | |||
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/records/616?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":{
"id": 616,
"name": "Test",
"created": 1586358993,
"author":{
"id": 1,
"name": "admin"
},
"type": "record",
"duration": 399,
"room":{
"id": 59,
"name": "Jared Test"
},
"cameras":{
"89": "Jared Test"
},
"sharing":{
"groups":[],
"users":[]
},
"retention":{
"type": "inherit"
},
"markers":[
{
"id": 33,
"event": "API Marker",
"time": -3,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 32,
"event": "API Marker",
"time": 0,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 21,
"event": "Test",
"time": 24,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 35,
"event": "API Marker",
"time": 30,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 36,
"event": "API Marker",
"time": 30,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 37,
"event": "API Marker",
"time": 30,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 38,
"event": "API Marker 1",
"time": 30,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 39,
"event": "API Marker 1",
"time": 30,
"color": "red",
"hex_color": "#ff0000",
"template":[{"Marker Name": "12345678" }]
},
{
"id": 40,
"event": "API Marker 2",
"time": 30,
"color": "red",
"hex_color": "#ff0000",
"template":[{"Marker Name": "12345678" }]
},
{
"id": 22,
"event": "Test 2",
"time": 98,
"color": "white",
"hex_color": "#ffffff",
"template":[]
},
{
"id": 31,
"event": "API Marker",
"time": 120,
"color": "red",
"hex_color": "#ff0000",
"template":[]
},
{
"id": 23,
"event": "Test 3",
"time": 157,
"color": "grey",
"hex_color": "#bcbcbc",
"template":[]
},
{
"id": 24,
"event": "Test 4",
"time": 240,
"color": "yellow",
"hex_color": "#ebeb00",
"template":[]
},
{
"id": 25,
"event": "Test 5",
"time": 249,
"color": "pink",
"hex_color": "#ff78f4",
"template":[]
},
{
"id": 26,
"event": "Test 6",
"time": 271,
"color": "turquoise",
"hex_color": "#00f2ff",
"template":[]
},
{
"id": 27,
"event": "Test 7",
"time": 271,
"color": "neon",
"hex_color": "#3c8aff",
"template":[]
},
{
"id": 28,
"event": "Test 8",
"time": 280,
"color": "green",
"hex_color": "#00c400",
"template":[]
},
{
"id": 29,
"event": "Test 9",
"time": 280,
"color": "orange",
"hex_color": "#ff9428",
"template":[]
},
{
"id": 30,
"event": "Test",
"time": 301,
"color": "red",
"hex_color": "#ff0000",
"template":[{"Marker Name": "Test" }, {"Notes": "Test" }]
},
{
"id": 34,
"event": "API Marker",
"time": 123123124,
"color": "red",
"hex_color": "#ff0000",
"template":[]
}
],
"videos":[
{
"url": "https://ivstest1.ad.ipivs.com:444/vod/_definst_/mp4:valt_recordings/video/616/1_616_89.mp4/playlist.m3u8",
"id": 89,
"name": "Jared Test"
}
]
}
}
Failure Response
{"error":{"code":401,"message":"No API key provided"}}
