{"id":3715,"date":"2021-09-28T19:22:45","date_gmt":"2021-09-28T11:22:45","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=3715"},"modified":"2025-03-06T14:47:54","modified_gmt":"2025-03-06T06:47:54","slug":"archive-route","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/server-api\/archive-route\/","title":{"rendered":"Video API &#8211; Get Recordings &#038; Chat-Scripts"},"content":{"rendered":"\n<blockquote class=\"wp-block-quote\"><p>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. <\/p><\/blockquote>\n\n\n\n<h4>Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#for-a-period\">Requesteing Archives for a Period<\/a><\/li><li><a href=\"#for-a-room\">Requesting Archives for a Room<\/a><\/li><li><a href=\"#for-a-room-period\">Requesting Archives for a Room &amp; Period<\/a><\/li><li><a href=\"#for-a-conf-num\">Requesting Archives for a Conference Number<\/a><\/li><li><a href=\"#recording-files-security\">Video Recording File Security<\/a><\/li><\/ul>\n\n\n\n<a name=\"for-a-period\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Requesting Archives for a Period<\/h2>\n\n\n\n<p>This API Route provides a filter for Archive Reporting. Note the usage of dates in the URL Structure.<\/p>\n\n\n\n<ul><li><strong>API Route:<\/strong> https:\/\/api.yourcpass.com\/video\/v2\/archive\/period\/{from_date}\/{to_date}<\/li><li><strong>HTTP Request:<\/strong> GET<\/li><li><strong>Date Format:<\/strong> YYYY-MM-DD<\/li><li><strong>Time Zone:<\/strong> UTC<\/li><\/ul>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.yourcpass.com\/video\/v2\/archive\/period\/{from_date}\/{to_date}  \nAuthorization: Basic XXXXXXX<\/pre>\n\n\n\n<a name=\"archive-response\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Response JSON<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">{\n     \"result\": \"0\",\n     \"archive\": [\n         {\n             \"_id\": \"XXX\",  \n             \"trans_date\": \"YYYY-MM-DDTHH:II:SS.mmmZ\",\n             \"conf_num\": \"XXXXX\",\n             \"app_id\": \"XXX\",\n             \"room_id\": \"XXX\",\n             \"recording\": [\n                 {\"url\": \"https:\/\/FQDN\/path\/file.mkv\"} \n             ],\n             \"transcoded\": [\n                 {\"url\": \"https:\/\/FQDN\/path\/file.mp4\"} \n             ],\n             \"chatdata\": \"https:\/\/FQDN\/path\/chatdata.json\",\n             \"metadata\": \"https:\/\/FQDN\/path\/metadata.json\"  \n         } \n     ]\n }<\/pre>\n\n\n\n<p>For more details on recorded files security, refer to the <a href=\"\/developer\/video\/workflow-automation\/video-recording-file-security\/\">Recording Files Security Documentation<\/a>  <\/p>\n\n\n\n<a name=\"for-a-room\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Requesting Archives for a Room<\/h2>\n\n\n\n<p>This API Route provides filter for  Archives Reporting for a Room. Note the usage of <code>room_id<\/code> in the URL Structure.<\/p>\n\n\n\n<ul><li><strong>API Route:<\/strong> https:\/\/api.yourcpass.com\/video\/v2\/archive\/room\/{room_id}<\/li><li><strong>HTTP Request:<\/strong> GET<\/li><\/ul>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.yourcpass.com\/video\/v2\/archive\/room\/{room_id}  \nAuthorization: Basic XXXXXXX<\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Response JSON<\/h4>\n\n\n\n<p><a href=\"#archive-response\">Response JSON<\/a> is same as example shown above. <\/p>\n\n\n\n<p>For more details on recorded files security, refer to the <a href=\"\/developer\/video\/workflow-automation\/video-recording-file-security\/\">Recording Files Security Documentation<\/a>   <\/p>\n\n\n\n<a name=\"for-a-room-period\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Requesting Archives for a Room &amp; Period<\/h2>\n\n\n\n<p>This API Route provides a filter for Archive Reporting for a specified Room and period. Note the usage of <code>from_date<\/code>, <code>to_date<\/code> and <code>room_id<\/code> in the URL Structure.<\/p>\n\n\n\n<ul><li><strong>API Route:<\/strong> https:\/\/api.yourcpass.com\/video\/v2\/archive\/room-period\/{room_id}\/{from-date}\/{to-date}  <\/li><li><strong>HTTP Request:<\/strong> GET<\/li><li><strong>Date Format:<\/strong> YYYY-MM-DD<\/li><li><strong>Time Zone:<\/strong> UTC<\/li><\/ul>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.yourcpass.com\/video\/v2\/archive\/room\/{room_id}  \nAuthorization: Basic XXXXXXX <\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Response JSON<\/h4>\n\n\n\n<p><a href=\"#archive-response\">Response JSON<\/a> is same as example shown above. <\/p>\n\n\n\n<p>For more details on recorded files security, refer to the <a href=\"\/developer\/video\/workflow-automation\/video-recording-file-security\/\">Recording Files Security Documentation<\/a>   <\/p>\n\n\n\n<a name=\"for-a-conf-num\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Requesting Archives for a Conference Number<\/h2>\n\n\n\n<p>This API Route provides a filter for the Archive for a Conference Note the usage of <code>conf_num<\/code> in the URL Structure.<\/p>\n\n\n\n<ul><li><strong>API Route:<\/strong> https:\/\/api.yourcpass.com\/video\/v2\/archive\/conf\/{conf-num}<\/li><li><strong>HTTP Request:<\/strong> GET<\/li><\/ul>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.yourcpass.com\/video\/v2\/archive\/conf\/{conf_num}  \nAuthorization: Basic XXXXXXX <\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Response JSON<\/h4>\n\n\n\n<p> <a href=\"#archive-response\">Response JSON<\/a> is same as example shown above. <\/p>\n\n\n\n<p>For more details on recorded files security, refer to the <a href=\"\/developer\/video\/workflow-automation\/video-recording-file-security\/\">Recording Files Security Documentation<\/a>   <\/p>\n\n\n\n<a name=\"recording-files-security\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Recording Files Security<\/h2>\n\n\n\n<p>Recorded files are not publicly accessible through HTTP URL. You can only access the recorded files via HTTP Basic Authentication Process. <\/p>\n\n\n\n<p>Note: To access\/download the recorded files within the specified date, kindly update your Business Application.<\/p>\n\n\n\n<p>For more details, refer to the <a href=\"\/developer\/video\/workflow-automation\/video-recording-file-security\/\">Recording Files Security Documentation<\/a> <\/p>\n","protected":false},"excerpt":{"rendered":"<p>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 Requesteing Archives for a Period Requesting Archives for a Room Requesting&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3712,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ub_ctt_via":""},"featured_image_src":null,"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"featured":false,"featured-large":false},"uagb_author_info":{"display_name":"vcxdevwpadmin","author_link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/author\/vcxdevwpadmin\/"},"uagb_comment_info":0,"uagb_excerpt":"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&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3715"}],"collection":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/comments?post=3715"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3715\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3712"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=3715"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}