Video API – Get Recordings & Chat-Scripts

Archive Route is used to get access to files created during RTC Sessions viz. Individual Recording Files, Transcoded Playable Video File, Chat Script File, Session Meta File. API call returns a JSON with the direct URL to download these files. To download each file, you need to do a HTTP GET to request the individual file.

Table of Contents

Requesting Archives for a Period

This API Route provides a filter for Archive Reporting. Note the usage of dates in the URL Structure.

  • API Route: https://api.yourcpass.com/video/v2/archive/period/{from_date}/{to_date}
  • HTTP Request: GET
  • Date Format: YYYY-MM-DD
  • Time Zone: UTC

Request Example

GET https://api.yourcpass.com/video/v2/archive/period/{from_date}/{to_date}  
Authorization: Basic XXXXXXX

Response JSON

{
     "result": "0",
     "archive": [
         {
             "_id": "XXX",  
             "trans_date": "YYYY-MM-DDTHH:II:SS.mmmZ",
             "conf_num": "XXXXX",
             "app_id": "XXX",
             "room_id": "XXX",
             "recording": [
                 {"url": "https://FQDN/path/file.mkv"} 
             ],
             "transcoded": [
                 {"url": "https://FQDN/path/file.mp4"} 
             ],
             "chatdata": "https://FQDN/path/chatdata.json",
             "metadata": "https://FQDN/path/metadata.json"  
         } 
     ]
 }

For more details on recorded files security, refer to the Recording Files Security Documentation

Requesting Archives for a Room

This API Route provides filter for Archives Reporting for a Room. Note the usage of room_id in the URL Structure.

  • API Route: https://api.yourcpass.com/video/v2/archive/room/{room_id}
  • HTTP Request: GET

Request Example

GET https://api.yourcpass.com/video/v2/archive/room/{room_id}  
Authorization: Basic XXXXXXX

Response JSON

Response JSON is same as example shown above.

For more details on recorded files security, refer to the Recording Files Security Documentation

Requesting Archives for a Room & Period

This API Route provides a filter for Archive Reporting for a specified Room and period. Note the usage of from_date, to_date and room_id in the URL Structure.

  • API Route: https://api.yourcpass.com/video/v2/archive/room-period/{room_id}/{from-date}/{to-date}
  • HTTP Request: GET
  • Date Format: YYYY-MM-DD
  • Time Zone: UTC

Request Example

GET https://api.yourcpass.com/video/v2/archive/room/{room_id}  
Authorization: Basic XXXXXXX

Response JSON

Response JSON is same as example shown above.

For more details on recorded files security, refer to the Recording Files Security Documentation

Requesting Archives for a Conference Number

This API Route provides a filter for the Archive for a Conference Note the usage of conf_num in the URL Structure.

  • API Route: https://api.yourcpass.com/video/v2/archive/conf/{conf-num}
  • HTTP Request: GET

Request Example

GET https://api.yourcpass.com/video/v2/archive/conf/{conf_num}  
Authorization: Basic XXXXXXX

Response JSON

Response JSON is same as example shown above.

For more details on recorded files security, refer to the Recording Files Security Documentation

Recording Files Security

Recorded files are not publicly accessible through HTTP URL. You can only access the recorded files via HTTP Basic Authentication Process.

Note: To access/download the recorded files within the specified date, kindly update your Business Application.

For more details, refer to the Recording Files Security Documentation