0% found this document useful (0 votes)
55 views17 pages

Airtel Cloud Communication Platform - CDR document v1.3[1]

The document provides a comprehensive overview of the Call Data Records (CDR) for the Airtel Cloud Communication Platform, detailing raw CDR fields, standard display formats, and sample logs for both outbound and inbound calls. It includes descriptions of various headers such as call status, duration, and participant information, along with examples of CDR logs. Additionally, it outlines the overall call status and the implications of different call outcomes.

Uploaded by

tawebas953
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
55 views17 pages

Airtel Cloud Communication Platform - CDR document v1.3[1]

The document provides a comprehensive overview of the Call Data Records (CDR) for the Airtel Cloud Communication Platform, detailing raw CDR fields, standard display formats, and sample logs for both outbound and inbound calls. It includes descriptions of various headers such as call status, duration, and participant information, along with examples of CDR logs. Additionally, it outlines the overall call status and the implications of different call outcomes.

Uploaded by

tawebas953
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 17

Airtel Cloud Communication

Platform - CDR Document

Confidential
Airtel Cloud Communication Platform – CDR Document

Table of Contents

1 Raw CDR Fields / Headers in the call logs:..................................................................... 3


1.1 *Caller & Destination Number Status detailing: ............................................................... 7
2 Standard CDR Field Display ............................................................................................ 8
3 Overall Call Status ........................................................................................................... 9
4 Sample CDR Logs for Outbound call: ........................................................................... 10
5 Sample CDR Logs for Inbound call:.............................................................................. 13

Confidential
Airtel Cloud Communication Platform – CDR Document

1 Raw CDR Fields / Headers in the call logs:


This document entails the description of Call Log / CDR’s which are posted on Enterprise shared API via
Airtel Cloud Communication Platform.
Headers in the Raw Call Data Records are captured below with description & sample:

Variables / Headers Description Sample

vmSessionId Application generated unique 5ea2aded87fcb12816bcd27b


session ID

clientCorrelationId This is the Xchange ID generated at Xchange12345678


session level. This Is unique field
used for searching the CDR logs in
the UI

customerId This is the customer name field in SWIGGY, FLIPKART etc.


the format stored by Airtel in system

startTime This field captures real time date in 1588163670384


& Epoch Timestamp format.
endTime

callAnswerTime This field captures real time date in 1588163671121


Epoch Timestamp format of when
the call is answered by the
destination party

Duration This is the summation of the caller 42495 which indicates 42.495
fromWaiting time and network time seconds
taken for ring to trigger.
Format: numeric in milliseconds

fromWaitingTime Duration for which the IVR was 41774 which indicates 41.774
played i.e. Duration when the seconds
welcome tone started and till the
time destination number picked the
call. Format: numeric in
milliseconds

conversationDuration The duration between when the call 12225 which indicates 12.225
was answered by Destination seconds
number AND the call ended.
Format: numeric in milliseconds

overallCallStatus This field indicates that call status Answered or Missed


between both the parties. E.g.
Answered, Missed, Disconnected,
Busy
Note: Missed is captured for no.
switched off, Not Reachable and No
Answer

onfidential
Airtel Cloud Communication Platform – CDR Document

hangUpStatus This field is captured basis which SYSTEM_INITIATED OR Party A


party has disconnected the call. OR Party B
E.g.: Party A or Party B
If the call is disconnected by the
system in events of call not
answered or max retries are
exhausted, this is captured as
“SYSTEM_INITIATED”

hangupCause Captures the cause of hangup. SYSTEM_INITATED or


USER_INITIATED
E.g. If the call disconnected by the
system after MaxTries are
exhausted, it is captured as
SYSTEM_INITIATED hung up.
In all other cases, user (either
destination or caller) hangs up the
call, this is captured
USER_INITIATED.

callType This field indicates whether the call INBOUND or OUTBOUND


is INBOUND or OUTBOUND
“Inbound” indicates that call
session is formed post receiving call
on Airtel provided number (Eg:
Number masking)
“Outbound” indicates that session
is formed post initiating call from
Airtel CLI to Caller (Eg:- Click to
Call)

callerId In case of Outbound – this is fixed “callerID”: “8045475030”


line no. from where the call has
been initiated to the destination no.
In case of Inbound – this is the no.
to which the call has been landed
on.

participantAddress This field captures the Caller No. in participantAddress":


case participantType is “To” and "8130773700",
Destination No. when the "participantType": "From"
participantType is “From”
Called made to below no.:

"participantAddress":
"9899543367",
“participantType": "To"

participantType This denotes “To” and “From” the "participantType": "From"


participantAddress "participantType": "To"

onfidential
Airtel Cloud Communication Platform – CDR Document

audioURL This field captures Sound File URL http://10.89.47.210:8088/CDS/airte


which can be played during the wait l_ironman/prompts/welcome_jll.wa
time of the call v

retryCount Number of retries before call is 1


picked up at caller no. or at
destination no. end

recordingURL URL from which user can fetch call HTTPS URL
recording. This is shared by the
customer

displayCliDestination Fixed Line number that is being “displayCliDestination”:


used for initiating call to destination “8045475030”
number

calledNumber This is applicable for call type-> "calledNumber": "8045475030"


inbound,Number on which call has
landed. This will be Airtel VN to
which the caller (Party A) will dial
i.e. incoming call to Airtel VN

callerNumber participantType ‘From’ number "callerNumber": "8130773700"

destinationNumber participantType ‘To’. Number "destinationNumber":


"9899543367"

callerNumberStatus* Action triggered for the call initiated "callerNumberStatus":


to the caller no. E.g. Disconnected, "Disconnected",
NetworkError, NotReachable, Busy
Noanswer, Removed, Answer
Please click here on the detailing
of these call status

callerNumberStatusDetails sip code, cause code and "callerNumberStatusDetails": "16 |


description, status of party A 699 | Normal call clearing |
(Answered, Not reachable etc.) Disconnected"
such as “16 | 699 | Normal Call
clearing| Busy”

callerDuration This is total call duration. Sum of 42495 which indicates 42.495
"fromWaitingTime" seconds
and "conversation Duration"
Format: numeric in milliseconds

destinationNumberStatus* Action triggered for the call initiated "destinationNumberStatus":


to the destination no. E.g. "Busy"
Disconnected, NetworkError,
NotReachable, Busy, Noanswer,
Removed, Answer
Please click here on the detailing
of these call status

onfidential
Airtel Cloud Communication Platform – CDR Document

destinationNumberStatusDetails sip code, cause code and "destinationNumberStatusDetails":


description, status of party B "17 | 486 | User Busy | Busy",
(Answered, Not reachable etc.)
such as “17 | 486 | User Busy |
Busy"

billableDuration This is billable duration of the caller. 42495 which indicates 42.495
Sum of "fromWaitingTime" seconds
and "conversation
Duration"
call type Inbound - conversation
duration
Call type Outbound - from waiting
time + 2* conversation duration
Format: numeric in milliseconds

circleNameCaller This field captures the circle from "circleNameCaller": "Delhi",


where the no. is registered

circleNameDestination This field captures the circle to "circleNameDestination": "Delhi",


which the call is made

operatorNameCaller This field captured the operator to "operatorNameCaller": "Bharti


which this no. is registered from Airtel (GSM)",

operatorNameDestination This field captured the operator to "operatorNameDestination":


which the destination no. is "Bharti Airtel (GSM)"
registered on

onfidential
Airtel Cloud Communication Platform – CDR Document

1.1 *Caller & Destination Number Status detailing:

Caller / Destination Number Status Remarks

Disconnected Call was disconnected by either party

NetworkError Error in network of the participant number (This status also shows up for
scenarios where the call was disconnected from the system as the other
participant disconnects the call, it comes for the cause code 500)

NotReachable The tried participant number was not reachable

Busy The tried participant number was busy

Noanswer The call was tried on the participant number but answer was not
answered
Removed The call was disconnected from the system end as the answer was not
received within the provided ring time

Answer The call was answered

onfidential
Airtel Cloud Communication Platform – CDR Document

2 Standard CDR Field Display in UI

Below are the standard display configured in the UI for 16 fields of the Call Data Record:

S No. Header Name As per Raw Header Display Name in CDR Format
CDR (Standard)
1 Date dd/mm/yy
timestamp
2 Time hh:mm:ss
3 clientCorrelationId Call_ID 1XXX
4 callerId Caller_ID 80xxxxxxxx
5 callerNumber Caller_Number 99xxxxxxxx
6 destinationNumber Destination_CLI 80xxxxxxxx
7 displayCliDestination Destination_Number 98xxxxxxxx
8 fromWaitingTime Caller_Waiting_Time mm:ss
9 conversationDuration Conversation_Duration mm:ss
10 overallCallStatus Overall_Call_Status Answered/Missed etc.
11 hangUpStatus Hangup_Cause Caller/Destination/System Initiated etc.
12 callerNumberStatus Caller_Status Disconnected / Answered etc.
13 destinationNumberStatus Destination_Status Disconnected / Answered / Network Error etc.
14 circleNameCaller Caller_Circle_Name State Name (Karnataka, Delhi etc.)
15 Pulse Pulse_Count Count of Pulses (1,2, etc.)
16 recordingURL Recording Audio Recording

onfidential
Airtel Cloud Communication Platform – CDR Document

3 Overall Call Status

Call status (Caller number) Call status(Destination number) Call Status (Overall)
Answer Answered Answered
Answer Busy Missed
Answer Missed Missed
Busy - Missed
Missed - Missed

onfidential
Airtel Cloud Communication Platform – CDR Document

4 Sample CDR Logs for Outbound call:


{
"vmSessionId" : "5e9161bXXXXXXXXXXX026",
"clientCorrelationId" : "Xchange25XXXXXX",
"customerId" : "AIRTEL_TEST",
"startTime" : 1586586038102,
"endTime" : 1586586113852,
"duration" : 75750,
"fromWaitingTime" : 22028,
"conversationDuration" : 48481,
"overallCallStatus" : "Answered",
"callType" : "OUTBOUND",
"callerId" : "9999999999",
"participants" : [
{
"participantAddress" : "9999999999",
"participantName" : "FROM_",
"participantType" : "From",
"callerId" : "9999999999",
"retryCount" : 1,
"startTime" : 1586586038156,
"endTime" : 1586586113852,
"callAnswerTime" : 1586586042893,
"duration" : 75696,
"status" : "Disconnected",
"hangupCause" : "SYSTEM_INITIATED"
},
{
"participantAddress" : "09999999999",
"participantName" : "TO_",
"participantType" : "To",
"callerId" : "9999999999",
"retryCount" : 1,
"startTime" : 1586586043206,
"endTime" : 1586586113402,
"callAnswerTime" : 1586586064921,
"duration" : 70196,
"status" : "Disconnected",
"hangupCause" : "USER_INITIATED"
}
],
"events" : [
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "CalledNumber",
"time" : 1586586039580,
"comments" : "call initiated on network"
},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "Ringing",
"time" : 1586586041144,

onfidential
Airtel Cloud Communication Platform – CDR Document

"comments" : "ring initiated from network"


},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "Answer",
"time" : 1586586042893
},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "CalledNumber",
"time" : 1586586043246,
"comments" : "call initiated on network"
},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "CallEarlyAnswered",
"time" : 1586586043874
},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "Ringing",
"time" : 1586586049358,
"comments" : "ring initiated from network"
},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "Answer",
"time" : 1586586064921
},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "Disconnected",
"time" : 1586586113398,
"metaData" : {
"causeCode" : "16",
"sipCode" : "699",
"causeCodeDescription" : "Normal call clearing"
}
},
{
"eventType" : "CALL",
"participantAddress" : "09999999999",
"event" : "Disconnected",
"time" : 1586586113850,
"metaData" : {
"causeCode" : "31",
"sipCode" : "500",
"causeCodeDescription" : "normal unspecified"
}
}

onfidential
Airtel Cloud Communication Platform – CDR Document

],
"timestamp" : "2020-04-11 06:22:08"
“displayCliDestination": "09999999999",
"calledNumber": "09999999999",
"callerNumber": "09999999999",
"destinationNumber": "09999999999",
"destinationName": "TO_",
"callerName": "FROM_",
"retryCountCaller": 1,
"callerNumberStatus": "Disconnected",
"callerNumberStatusDetails": "31 | 500 | normal unspecified | “Disconnected",
"callerDuration": 22028,
"destinationNumberStatus": "NotReachable",
"destinationNumberStatusDetails": "31 | 480 | normal unspecified | NotReachable",
"retryCountDestination": 1,
"billableDuration": 22028,
"callSetupTimeCaller": 135,
"circleNameCaller": "Delhi",
"circleNameDestination": "Delhi",
"operatorNameCaller": "Bharti Airtel (GSM)",
"operatorNameDestination": "Bharti Airtel (GSM)"
}

onfidential
Airtel Cloud Communication Platform – CDR Document

5 Sample CDR Logs for Inbound call:


{
"vmSessionId": "5eaabXXXXXXXXXX41750",
"clientCorrelationId": "Xchange1XXXXXXX”,
"customerId": “AIRTEL_TEST”,
"startTime": 1588245660890,
"endTime": 1588245720805,
"duration": 59915,
"fromWaitingTime": 11635,
"conversationDuration": 47320,
"overallCallStatus": "Answered",
"callType": "INBOUND",
"callerId": “8045805201”,
"participants": [
{
"participantAddress": “9999999999”,
"participantType": "From",
"startTime": 1588245660890,
"endTime": 1588245720617,
"callAnswerTime": 1588245661850,
"duration": 59727,
"status": "Disconnected",
"hangupCause": "USER_INITIATED",
"audios": [
{
"audioURL": "ring2.wav",
"status": "Stopped"
}
]
},
{
"participantAddress": “9999999999”,
"participantType": "To",
"callerId": "8045805201",
"retryCount": 1,
"startTime": 1588245662077,
"endTime": 1588245720805,
"callAnswerTime": 1588245673485,
"duration": 58728,
"status": "Disconnected",
"hangupCause": "SYSTEM_INITIATED",
"audios": []
}
],
"recordingURL": "https://openapi.airtel.in/gateway/airtel-xchange-
reporting/recordingFile?recording=gLTIM5uvaO6TqDKxxxxxxxxxxxxxxxxxxx+gB23jxRRSAoa/KNJxxxxxx
xxxxxxxxxxxxxxug==",
"audios": [],
"events": [
{
"eventType": "CALL",
"participantAddress": “9999999999”,
"event": "Answer",
"time": 1588245661850

onfidential
Airtel Cloud Communication Platform – CDR Document

},
{
"eventType": "CALL",
"participantAddress": “09999999999”,
"event": "CalledNumber",
"time": 1588245662175,
"comments": "call initiated on network"
},
{
"eventType": "CALL",
"participantAddress": “099999999999”,
"event": "Answer",
"time": 1588245673485
},
{
"eventType": "MEDIA",
"participantAddress": “9999999999”,
"event": "Stopped",
"time": 1588245673934,
"metaData": {
"audioUrl": "ring2.wav"
},
"comments": "Media file play stopped"
},
{
"eventType": "CALL",
"participantAddress": “9999999999”,
"event": "Disconnected",
"time": 1588245720614,
"metaData": {
"causeCode": "16",
"sipCode": "699",
"causeCodeDescription": "Normal call clearing"
}
},
{
"eventType": "CALL",
"participantAddress": “9999999999”,
"event": "Disconnected",
"time": 1588245720802,
"metaData": {
"causeCode": "31",
"sipCode": "500",
"causeCodeDescription": "normal unspecified"
}
}
],
"timestamp": "2020-04-30 11:22:15",
"displayCliDestination": “9999999999”,
"calledNumber": “9999999999”,
"callerNumber": “9999999999”,
"destinationNumber": “09999999999”,
"callerNumberStatus": "Disconnected",
"callerNumberStatusDetails": "16 | 699 | Normal call clearing | Disconnected",
"callerDuration": 58955,
"destinationNumberStatus": "Disconnected",

onfidential
Airtel Cloud Communication Platform – CDR Document

"destinationNumberStatusDetails": "31 | 500 | normal unspecified | Disconnected",


"retryCountDestination": 1,
"billableDuration": 47320,
"circleNameCaller": "Delhi",
"circleNameDestination": "Delhi",
"operatorNameCaller": "Bharti Airtel (GSM)",
"operatorNameDestination": "Reliance Jio (GSM)"
}

onfidential
Airtel Cloud Communication Platform – CDR Document

6 Dashboard Standard View


Below snapshots give a view of sample standard dashboard for any customer. Same is subjected to
customization basis customer request. Additional timelines may apply:

User can select the timeframe for


viewing the statistics of data.
For e.g. Data required for “This week”
or “customized date”

This graph reflects the Call Trend for Missed or Answered and Demographic View of the States from
where the Call was received.

onfidential
Airtel Cloud Communication Platform – CDR Document

These graph reflects the Destination number status and Daily Call Trend

Below statistic & graphs reflect the:


- Avg. Customer Waiting Time: Avg. Duration for which the IVR was played i.e. Duration when the
welcome tone started and till the time destination number picked the call.

- Avg. Conversation Duration: The duration between when the call was answered by Destination
number AND the call ended.

- Call Volume by CLI of the Caller with mapping of the Call Status, Call Type & Count

onfidential

You might also like