Get callRecord
Namespace: microsoft.graph.callRecords
Retrieve the properties and relationships of a callRecord object.
There are two ways to get the id of a callRecord:
- Subscribe to change notifications to the
/communications/callRecords
endpoint. - Use the callChainId property of a call. The call record is available only after the associated call is completed.
Warning
A call record is created after a call or meeting ends and will remain available for 30 days. Requests for call records older than 30 days will receive a 404 Not Found
response.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Not supported. |
Delegated (personal Microsoft account) | Not supported. |
Application | CallRecords.Read.All |
HTTP request
GET /communications/callRecords/{id}
Optional query parameters
This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token} |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and the requested microsoft.graph.callRecords.callRecord object in the response body. A request for a call record older than 30 days will receive a 404 Not Found
response.
Examples
Example 1: Get basic details
Request
The following is an example of the request to get the basic details from a callRecord.
GET https://graph.microsoft.com/v1.0/communications/callRecords/{id}
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords/$entity",
"version": 1,
"type": "peerToPeer",
"modalities": [
"audio"
],
"lastModifiedDateTime": "2020-02-25T19:00:24.582757Z",
"startDateTime": "2020-02-25T18:52:21.2169889Z",
"endDateTime": "2020-02-25T18:52:46.7640013Z",
"id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
"organizer": {
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
},
"participants": [
{
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
},
{
"user": {
"id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
"displayName": "Owen Franklin",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
]
}
Example 2: Get full details
Request
The following is an example of the request to get the full details from a callRecord, including session and segment components.
GET https://graph.microsoft.com/v1.0/communications/callRecords/{id}?$expand=sessions($expand=segments)
Response
The following is an example of the response. If the sessions list is truncated, a sessions@odata.nextLink
value will be provided to retrieve the next page of sessions. The default page size for sessions is 60 entries.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords(sessions(segments()))/$entity",
"version": 1,
"type": "peerToPeer",
"modalities": [
"audio"
],
"lastModifiedDateTime": "2020-02-25T19:00:24.582757Z",
"startDateTime": "2020-02-25T18:52:21.2169889Z",
"endDateTime": "2020-02-25T18:52:46.7640013Z",
"id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
"organizer": {
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
},
"participants": [
{
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
},
{
"user": {
"id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
"displayName": "Owen Franklin",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
],
"sessions": [
{
"modalities": [
"audio"
],
"startDateTime": "2020-02-25T18:52:21.2169889Z",
"endDateTime": "2020-02-25T18:52:46.7640013Z",
"id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
"caller": {
"@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
"userAgent": {
"@odata.type": "#microsoft.graph.callRecords.clientUserAgent",
"headerValue": "RTCC/7.0.0.0 UCWA/7.0.0.0 AndroidLync/6.25.0.27 (SM-G930U Android 8.0.0)",
"platform": "android",
"productFamily": "skypeForBusiness"
},
"identity": {
"@odata.type": "#microsoft.graph.identitySet",
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
},
"callee": {
"@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
"userAgent": {
"@odata.type": "#microsoft.graph.callRecords.clientUserAgent",
"headerValue": "UCCAPI/16.0.12527.20122 OC/16.0.12527.20194 (Skype for Business)",
"platform": "windows",
"productFamily": "skypeForBusiness"
},
"identity": {
"user": {
"id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
"displayName": "Owen Franklin",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
},
"feedback": {
"rating": "poor",
"tokens": {
"NoSound": false,
"OtherNoSound": false,
"Echo": false,
"Noisy": true,
"LowVolume": false,
"Stopped": false,
"DistortedSound": false,
"Interruptions": false
}
}
},
"segments": [
{
"startDateTime": "2020-02-25T18:52:21.2169889Z",
"endDateTime": "2020-02-25T18:52:46.7640013Z",
"id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
"caller": {
"@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
"userAgent": {
"@odata.type": "#microsoft.graph.callRecords.clientUserAgent",
"headerValue": "RTCC/7.0.0.0 UCWA/7.0.0.0 AndroidLync/6.25.0.27 (SM-G930U Android 8.0.0)",
"platform": "android",
"productFamily": "skypeForBusiness"
},
"identity": {
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
},
"callee": {
"@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
"userAgent": {
"@odata.type": "#microsoft.graph.callRecords.clientUserAgent",
"headerValue": "UCCAPI/16.0.12527.20122 OC/16.0.12527.20194 (Skype for Business)",
"platform": "windows",
"productFamily": "skypeForBusiness"
},
"identity": {
"user": {
"id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
"displayName": "Owen Franklin",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
},
"media": [
{
"label": "main-audio",
"callerNetwork": {
"ipAddress": "10.150.0.2",
"subnet": "10.150.0.0",
"linkSpeed": 54000000,
"connectionType": "wifi",
"port": 27288,
"reflexiveIPAddress": "127.0.0.2",
"relayIPAddress": "52.114.188.32",
"relayPort": 53889,
"macAddress": "00-00-00-00-00-00",
"dnsSuffix": null,
"sentQualityEventRatio": 0,
"receivedQualityEventRatio": 0.27,
"delayEventRatio": 0,
"bandwidthLowEventRatio": 0
},
"calleeNetwork": {
"ipAddress": "10.139.0.12",
"subnet": "10.139.80.0",
"linkSpeed": 4294967295,
"connectionType": "wired",
"port": 50011,
"reflexiveIPAddress": "127.0.0.2",
"relayIPAddress": "52.114.188.102",
"relayPort": 52810,
"macAddress": "00-00-00-00-00-00-00-00",
"dnsSuffix": null,
"sentQualityEventRatio": 0.31,
"receivedQualityEventRatio": 0,
"delayEventRatio": 0,
"bandwidthLowEventRatio": 0
},
"callerDevice": {
"captureDeviceName": "Default input device",
"renderDeviceName": "Default output device",
"receivedSignalLevel": -10,
"receivedNoiseLevel": -68,
"initialSignalLevelRootMeanSquare": 60.25816,
"renderZeroVolumeEventRatio": 1,
"renderMuteEventRatio": 1,
"micGlitchRate": 23,
"speakerGlitchRate": 3830
},
"calleeDevice": {
"captureDeviceName": "Microphone (Microsoft Virtual Audio Device (Simple) (WDM))",
"captureDeviceDriver": "Microsoft: 5.0.8638.1100",
"renderDeviceName": "Speakers (Microsoft Virtual Audio Device (Simple) (WDM))",
"renderDeviceDriver": "Microsoft: 5.0.8638.1100",
"receivedSignalLevel": -14,
"receivedNoiseLevel": -86,
"initialSignalLevelRootMeanSquare": 146.7885,
"micGlitchRate": 143,
"speakerGlitchRate": 182
},
"streams": [
{
"streamId": "1504545584",
"streamDirection": "callerToCallee",
"averageAudioDegradation": null,
"averageJitter": "PT0.016S",
"maxJitter": "PT0.021S",
"averagePacketLossRate": 0,
"maxPacketLossRate": 0,
"averageRatioOfConcealedSamples": null,
"maxRatioOfConcealedSamples": null,
"averageRoundTripTime": "PT0.061S",
"maxRoundTripTime": "PT0.079S",
"packetUtilization": 67,
"averageBandwidthEstimate": 9965083,
"wasMediaBypassed": false,
"averageAudioNetworkJitter": "PT0.043S",
"maxAudioNetworkJitter": "PT0.046S"
},
{
"streamId": "1785122252",
"streamDirection": "calleeToCaller",
"averageAudioDegradation": 1.160898,
"averageJitter": "PT0.007S",
"maxJitter": "PT0.012S",
"averagePacketLossRate": 0.01381693,
"maxPacketLossRate": 0.03738318,
"averageRatioOfConcealedSamples": 0.06233422,
"maxRatioOfConcealedSamples": 0.07192807,
"averageRoundTripTime": "PT0.064S",
"maxRoundTripTime": "PT0.106S",
"packetUtilization": 709,
"averageBandwidthEstimate": 15644878,
"wasMediaBypassed": false,
"averageAudioNetworkJitter": "PT0.266S",
"maxAudioNetworkJitter": "PT0.474S"
}
]
}
]
}
]
}
],
"sessions@odata.nextLink": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/sessions?$expand=segments&$skiptoken=abc"
}
Feedback
Submit and view feedback for