{"id":7242,"date":"2025-04-03T17:01:25","date_gmt":"2025-04-03T09:01:25","guid":{"rendered":"https:\/\/doc.smartflomeet.ttns.in\/developer\/?page_id=7242"},"modified":"2025-04-03T17:05:49","modified_gmt":"2025-04-03T09:05:49","slug":"cdr-route","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/server-api\/cdr-route\/","title":{"rendered":"Video API &#8211; Get CDR"},"content":{"rendered":"\n<h4 class=\"wp-block-heading\">Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#for-a-period\">Requesting CDR for a specific period<\/a><\/li><li><a href=\"#for-a-room\">Requesting CDR for a specified Room<\/a><\/li><li><a href=\"#for-a-room-period\">Requesting CDR for a Room &amp; Period<\/a><\/li><li><a href=\"#for-a-conf-num\">Requesting CDR for a Conference Number<\/a><\/li><\/ul>\n\n\n\n<a name=\"for-a-period\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\">Requesting CDR for a specific period<\/h2>\n\n\n\n<p>This API Route deploys a filter on the CDR Reporting. API call returns CDR for a given period, i.e. between given FROM and TO date. Note the usage of dates in the URL Structure.<\/p>\n\n\n\n<ul><li><strong>API Route:<\/strong> https:\/\/api.smartflomeet.ttns.in\/video\/v2\/cdr\/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 class=\"wp-block-heading\">Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.smartflomeet.ttns.in\/video\/v2\/cdr\/period\/{from_date}\/{to_date}  \nAuthorization: Basic XXXXXXX<\/pre>\n\n\n\n<a name=\"cdr-response\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4 class=\"wp-block-heading\">Response JSON<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">{\n  \"result\": \"0\",\n  \"cdr\": [\n    {\n      \"trans_date\": \"YYYY-MM-DDTHH:MI:SS.mlsZ\",\n      \"conf_num\": \"String\",\n      \"sip\": false,\n      \"call_num\": \"String\",\n      \"call_log_id\": \"String\",\n      \"parent_partner_id\": \"String\",\n      \"room\": {\n        \"room_id\": \"String\",\n        \"connect_dt\": \"YYYY-MM-DDTHH:MI:SS.mlsZ\",\n\t\"disconnect_dt\": \"YYYY-MM-DDTHH:MI:SS.mlsZ\",\n        \"duration\": 999,\n        \"room_details\": {},\n        \"sip\": false\n      },\n      \"user\": {\n        \"role\": \"moderator\/participant\/viewer\/audience\",\n        \"ip\": \"String\",\n        \"name\": \"String\",\n        \"ref\": \"String\",\n        \"agent\": \"String\"\n      },\n      \"sigserver\": {\n        \"disconnect_dt\": \"YYYY-MM-DDTHH:MI:SS.mlsZ\",\n        \"connect_dt\": \"YYYY-MM-DDTHH:MI:SS.mlsZ\",\n        \"ip\": \"String\",\n        \"duration\": 999.99,\n        \"hold_duration\": 9.99\n      },\n      \"published_track\": {\n        \"audio\": true,\n        \"data\": false,\n        \"video\": true,\n        \"screen\": false,\n        \"url\": false\n      },\n      \"usage\": {\n        \"subscribed_minutes\": 999,\n        \"published_minutes\": 999,\n        \"screen_minutes\": 999,\n        \"connect_minutes\": 999,\n        \"connect_minutes_cal\": 999,\n        \"room_connect_minutes\": 999\n      },\n     \"stats_quality\": {\n        \"send\": {\n          \"video\": {\n            \"avg_bitrate\": 999,\n            \"avg_bitrate_quality\": \"Good\/Bad\",\n            \"max_bitrate\": 999,\n            \"min_bitrate\": 999\n          },\n          \"sharing\": {},\n          \"audio\": {\n            \"avg_bitrate\": 999,\n            \"avg_bitrate_quality\": \"Good\/Bad\",\n            \"max_bitrate\": 999,\n            \"min_bitrate\": 999\n          }\n        },\n        \"receive\": {\n          \"video\": {\n            \"avg_bitrate\": 999,\n            \"avg_bitrate_quality\": \"Good\/Bad\",\n            \"max_bitrate\": 999,\n            \"min_bitrate\": 999,\n            \"bitrate_good_percent\": 999,\n            \"bitrate_moderate_percent\": 999,\n            \"bitrate_bad_percent\": 999\n          },\n          \"sharing\": {},\n          \"audio\": {\n            \"avg_bitrate\": 41020,\n            \"avg_bitrate_quality\": \"Good\/Bad\",\n            \"max_bitrate\": 42752,\n            \"min_bitrate\": 38231,\n            \"bitrate_good_percent\": 100,\n            \"bitrate_moderate_percent\": 0,\n            \"bitrate_bad_percent\": 0\n          },\n          \"rtt\": {}\n        },\n        \"call_quality\": \"Good\/Bad\"\n      },\n      \"video_embed\": true,\n      \"visual_builder\": true,\n      \"lowcode\": true,\n      \"app_id\": \"String\",\n      \"cdr_id\": \"String\"\n    }\n  ]\n}<\/pre>\n\n\n\n<p><strong>JSON Explanation<\/strong><\/p>\n\n\n\n<ul><li><code>trans_date<\/code>: CDR log time.<\/li><li><code>conf_num<\/code>: This is \u201cConference Number\u201d or \u201cSession Identifier\u201d. Assigned by Video Service. By definition, each video room may be used for one or multiple session. This identifies each session in a video room.<\/li><li><code>call_num<\/code>: This is \u201cCall Number\u201d,&nbsp; i.e., a user\u2019s connection identifier. Assigned by Video Service. &nbsp;Each connected user is identified with this in a session.<\/li><li><code>call_log_id<\/code>: This is \u201cLog ID\u201d. Assigned by Video Service for logging of all events, activities, issues. Any issue in a session can be traced by \u201cLog ID\u201d post session. EnableX asks for \u201cLog ID&#8221; to trace any issue in session.<\/li><li><code>parent_partner_id<\/code>: This is \u201cPartner ID\u201d or \u201cCustomer ID\u201d. Each EnableX Project is owned by EnableX Customer. So, CDR too has it. &nbsp;<\/li><li><code>app_id<\/code>: Application ID.<\/li><li><code>cdr_id<\/code>: CDR ID. ID of CDR entry in database.<\/li><li><code>lowcode<\/code>: Boolean. It indicates if Low-Code is used.<\/li><li><code>room<\/code>: Object with Room \/ Session related information.<\/li><li><code>room.room_id<\/code>: Room ID.<\/li><li><code>room.connect_dt<\/code>: User\u2019s connection time to the Video Room.<\/li><li><code>room.disconnect_dt<\/code>: User\u2019s disconnection time to the Video Room.<\/li><li><code>room.duration<\/code>: Total Duration the user remain connected in the Video Room. It\u2019s in Second.<\/li><li><code>room.room_details<\/code>: Object. It includes complete Room Definition.<\/li><li><code>user<\/code>: Object. It has information about the connected user.<\/li><li><code>user.role<\/code>: User Role. This was passed while creating Token to join Video Room.<\/li><li><code>user.ip<\/code>: IP Address of the user from where he was connected.<\/li><li><code>user.name<\/code>: User name. This was passed while creating Token to join Video Room.<\/li><li><code>user.ref<\/code>: User Reference Number. This was passed while creating Token to join Video Room.<\/li><li><code>user.agent<\/code>: User Agent information of the end point from where the user was connected.<\/li><li><code>sigserver<\/code>: Object. It contains information about EnableX Signalling Server to which the user is connected. &nbsp;<\/li><li><code>published_track<\/code>: Object. It contains different type of media stream that the user has used.<\/li><li><code>published_track.audio<\/code>: User has used microphone feed.<\/li><li><code>published_track.video:<\/code> User has used camera feed.<\/li><li><code>published_track.screen:<\/code> User has shared screen.<\/li><li><code>usage<\/code>: Object. Usage, rounded up to next second.<\/li><li><code>usage.published_minutes:<\/code> Total Time in Second for which user has published his own stream into the Room.<\/li><li><code>usage.screen_minutes:<\/code> Total Time in Second for which user has shared screen into the Room.<\/li><li><code>usage.connect_minutes:<\/code> Total Time in Second for which user remained connected to the Room.<\/li><li><code>usage.connect_minutes_cal:<\/code> Total calculated time in minutes (rounded up) for which user remained connected to video room. This is the time for which you are billed for user\u2019s connection.<\/li><li><code>stats_quality<\/code>: This object contains information about call quality for audio, video and screen sharing for both sending and receiving streams.<\/li><li><code>stats.quality.send:<\/code> This child object contains quality stats for published audio, video and screen sharing stream.<\/li><li><code>stats.quality.receive<\/code>: This child object contains quality stats for received audio, video and screen sharing stream. Data for each of these streams is contained in related child objects named as \u201caudio\u201d, \u201cvideo\u201d and \u201csharing\u201d.<\/li><li><code>stats.quality.receive<\/code>: This child object contains quality stats for received audio, video and screen sharing stream. Data for each of these streams is contained in related child objects named as \u201caudio\u201d, \u201cvideo\u201d and \u201csharing\u201d.<\/li><\/ul>\n\n\n\n<a name=\"for-a-room\"><\/a>\n\n\n\n<h2 class=\"wp-block-heading\">Requesting CDR for a specified Room<\/h2>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>This API Route provides a filter for Room id for CDR Reporting. <\/p>\n\n\n\n<ul><li><strong>API Route:<\/strong> https:\/\/api.smartflomeet.ttns.in\/video\/v2\/cdr\/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 class=\"wp-block-heading\">Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.smartflomeet.ttns.in\/video\/v2\/cdr\/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 class=\"wp-block-heading\">Response JSON<\/h4>\n\n\n\n<p><a href=\"#cdr-response\">Response JSON<\/a> is same as example shown above.<\/p>\n\n\n\n<a name=\"for-a-room-period\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\">Requesting CDR for a Room &amp; Period<\/h2>\n\n\n\n<p>This API Route deploys a filter on the CDR Reporting. API call returns CDR for a given room and period. The specified date and Room ID format is described below in the URL Structure.<\/p>\n\n\n\n<ul><li><strong>API Route: <\/strong>https:\/\/api.smartflomeet.ttns.in\/video\/v2\/cdr\/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 class=\"wp-block-heading\">Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.smartflomeet.ttns.in\/video\/v2\/cdr\/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 class=\"wp-block-heading\">Response JSON<\/h4>\n\n\n\n<p><a href=\"#cdr-response\">Response JSON<\/a> is same as example shown above. <\/p>\n\n\n\n<a name=\"for-a-conf-num\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\">Requesting CDR for a Conference Number<\/h2>\n\n\n\n<p>This API Route provides a filter for Conference Number CDR Reporting. 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.smartflomeet.ttns.in\/video\/v2\/cdr\/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 class=\"wp-block-heading\">Request Example<\/h4>\n\n\n\n<pre class=\"wp-block-preformatted\">GET https:\/\/api.smartflomeet.ttns.in\/video\/v2\/cdr\/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 class=\"wp-block-heading\">Response JSON<\/h4>\n\n\n\n<p><a href=\"#cdr-response\">Response JSON<\/a> is same as example shown above. <\/p>\n","protected":false},"excerpt":{"rendered":"<p>Table of Contents Requesting CDR for a specific period Requesting CDR for a specified Room Requesting CDR for a Room &amp; Period Requesting CDR for a Conference Number Requesting CDR for a specific period This API Route deploys a filter on the CDR Reporting. API call returns CDR for a given period, i.e. between given FROM and TO date. Note the usage of dates in the URL Structure. API Route:&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3712,"menu_order":0,"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":"Table of Contents Requesting CDR for a specific period Requesting CDR for a specified Room Requesting CDR for a Room &amp; Period Requesting CDR for a Conference Number Requesting CDR for a specific period This API Route deploys a filter on the CDR Reporting. API call returns CDR for a given period, i.e. between given&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/7242"}],"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=7242"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/7242\/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=7242"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}