Post Session Reports can be accessed using Portal or using Server API Call from your Application Server. We provide different methods for delivery of reports.

Table of Contents

Call Detail Report (CDR)

Call Detail Report or CDR offers a complete log of activities from the time when a user is connected to a room until he is disconnected. CDR helps you understand EnableX usage by your application for each call session.

There are different ways through which you may get CDR, these are:

Fetch using Server API

Using Server API you can fetch CDR through a HTTP and get a request to its cdr route. You may use the following filters to get the right set of CDR required:

  • For a Period – For a given From and To date
  • For a Room ID
  • For a Room ID within a Period
  • For a specific Session – For a given Conference Number

Please refer to online documentation for a detailed explanation of API calls.

Download through Portal

Login to your Portal to download CDR for selected Period. You may further opt for the download format either in .CSV or .XLS. Follow the path:

Portal Login > Reports (Left Bar) > CDR > [Download]

Receive by Email

You may opt to receive CDR by email on a daily basis. Through your Portal, you may set up Email Delivery of CDR. Follow the path:

Portal Login > My Account (Left Bar) > Preferences > Notification Management > Transaction Notification (Section) > CDR (Checkbox) > [Save]

Archives

The term Archive refers to the following files created and saved during a RTC Session on EnableX Platform:

  1. Individual Participants Stream Recordings: Available only if you have subscribed to it and have recorded your sessions.
  2. Transcoded Re-playable Session:  It’s a single composite video file created out of all the individual participant’s streams in the right playtime. Available only if you have subscribed to it and recorded your sessions.
  3. Chat Scripts: A JSON File containing Chat-scripts if Participants used text-chat during a session. it only includes Public Chat and NOT Private Messaging.
  4. Session Meta File: A JSON File containing important events during a RTC Session with timestamps. e.g. User Published & Unpublished Streams, User joins and leaves Room, Active Talker List updates, Recording Starts & stops etc.

There are different ways through which you may access Archives, they are:

Fetch using Server API

Using Server API you can fetch Archive Reports through a HTTP GET request to its archive route. You may use the following filters to get the right set of Archive Report as designed:

  • For a Period – For a given From and To date
  • For a Room ID
  • For a Room ID within a Period
  • For a specific Session – For a given Conference Number

After getting the Archive Report, you may need to do HTTP GET to each of the URLs given in the Report to download files individually.

Please refer to online documentation for detailed explanation of API calls.

Get delivered to FTP / SFTP Server

EnableX may deliver your archived files to your FTP / SFTP Server.  FTP Delivery is carried out in batches; so you may need to wait for considerable amount of time to get deliverables on your Server.

You need to setup FTP Delivery with FTP Credentials through Portal. Follow the path:

Portal Login > My Accounts >  Preferences > Recording Delivery Management

Once configured, EnableX transfers your files and keep them organized in sub-folders in the folder you designated for delivery in your FTP Server. Sub-folders are named as:

FTP-Server/Designated-Folder/App-ID/Room-ID/Conference-Num/filesname.extn

Download through Portal

Login to your Portal to download Archives for selected Period. Follow the path:

Portal Login > Downloads (Left Bar) > Recordings > Download (Column of each Row)

Get notified through Notification URL

EnableX may notify you as soon as any archive file is available for downloading by HTTP POST to a designated Notification URL. You need to setup the URL at your Application Server. To configure your Notification URL, follow the path:

Portal Login > My Applications (Left Bar) > Action (Column of Each Row) > Manage Application > Settings (Tab) > Notification URL (Input)

Once configured, EnableX does HTTP POST with JSON Raw Body to the URL for you to process. Note that you need to do HTTP GET to each of the URLs given in the JSON to download files individually. JSON Format given below:

// When a Recording files are ready 
{	
	“type”: “recording”,
	“trans_date”: “Datetime”,  /* In UTC */
	“app_id”: “String”,
	“room_id”: “String”,
	“conf_num”: “String”,
	“recording”: [ 
		{ "url": "http://FQDN/path/file" }
	]
}

// When Transcoded Video files is ready
{	
	“type”: “transcoded”,
	“trans_date”: “Datetime”,  /* In UTC */
	“app_id”: “String”,
	“room_id”: “String”,
	“conf_num”: “String”,
	“transcoded”: [ 
		{ "url": "http://FQDN/path/file" }
	]
}

// When Chat Scripts are ready 
{
	“type”: “chatdata”,
	“trans_date”: “Datetime”,  /* In UTC */
	“app_id”: “String”,
	“room_id”: “String”,
	“conf_num”: “String”,
	“chatdata”: [ 
		{ "url": "http://FQDN/path/file" }
	]
}

Explore Developer Guide