Call Detail Report (CDR) which can be accessed via CDR Route contains individual usage information by each user during entire call session.

Table of Contents

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: https://api.enablex.io/v1/cdr/period/{from_date}/{to_date}
  • HTTP Request: GET
  • Date Format: YYYY-MM-DD
  • Time Zone: UTC

Request Example

GET https://api.enablex.io/v1/cdr/period/{from_date}/{to_date}  
Authorization: Basic XXXXXXX

Response JSON

{
     "result": "0",
     "cdr": [
         {
             "trans_date": "YYYY-MM-DDTHH:II:SS.mmmZ",
             "conf_num": "XXX",
             "call_num": "XXX",
             "call_log_id": "XXX",
             "room": {
                 "room_id": "XXXX",
                 "connect_dt": "YYYY-MM-DDTHH:II:SS.mmmZ",
                 "disconnect_dt": "YYYY-MM-DDTHH:II:SS.mmmZ",
                 "duration": 9999.999
             },
             "conference": {
                 "start_dt": "YYYY-MM-DDTHH:II:SS.mmmZ",
                 "end_dt": "YYYY-MM-DDTHH:II:SS.mmmZ",
                 "duration": 9999.999
             },
             "user": {
                 "ip": "1.1.1.1",
                 "name": "",
                 "role": "moderator",
                 "ref": "",
                 "agent": "okhttp/3.5.0",
                 "token": "",
                 "confName": ""
             },
             "sigserver": {
                 "connect_dt": "YYYY-MM-DDTHH:II:SS.mmmZ",
                 "ip": "",
                 "disconnect_dt": "YYYY-MM-DDTHH:II:SS.mmmZ",
                 "duration": 9999.999,
                 "hold_duration": 9.999
             },
             "published_track": {
                 "audio": "true",
                 "data": "true",
                 "video": "true",
                 "screen": "false",
                 "url": "false"
             },
             "usage": {
                 "subscribed_minutes": 9999.999,
                 "published_minutes": 9999.999
             },
             "app_id": "xyzxyzxyz",
             "cdr_id": "abcabcabc"
         }
     ]
 }

Requesting CDR for a specified Room

This API Route provides a filter for Room id for CDR Reporting.

  • API Route: https://api.enablex.io/v1/cdr/room/{room_id}
  • HTTP Request: GET

Request Example

GET https://api.enablex.io/v1/cdr/room/{room_id}  
Authorization: Basic XXXXXXX

Response JSON

Response JSON is same as example shown above.

Requesting CDR for a Room & Period

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.

  • API Route: https://api.enablex.io/v1/cdr/room-period/{room_id}/{from-date}/{to-date}
  • HTTP Request: GET
  • Date Format: YYYY-MM-DD
  • Time Zone: UTC

Request Example

GET https://api.enablex.io/v1/cdr/room/{room_id}  
Authorization: Basic XXXXXXX 

Response JSON

Response JSON is same as example shown above.

Requesting CDR for a Conference Number

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

  • API Route: https://api.enablex.io/v1/cdr/conf/{conf-num}
  • HTTP Request: GET

Request Example

GET https://api.enablex.io/v1/cdr/conf/{conf_num}  
Authorization: Basic XXXXXXX 

Response JSON

Response JSON is same as example shown above.