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.
You can use the $expand
query parameter to optionally include session and segment details, as shown in the Get full details example. When you expand session details, the maximum page size is 60 sessions.
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.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Not supported. | Not supported. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | CallRecords.Read.All | Not available. |
HTTP request
GET /communications/callRecords/{id}
Optional query parameters
This method supports the following OData query parameters to help customize the response. For general information, see OData query parameters.
Name | Description |
---|---|
$select | Use the $select query parameter to return a set of properties that are different than the default set for an individual resource or a collection of resources. Only supported for callRecord and session resources. |
$expand | Use the $expand query parameter to include the expanded resource or collection referenced by a single relationship in your results. |
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Prefer: odata.maxpagesize={x} | Specifies a preferred integer {x} page size for paginated results. Optional. This value must be equal to or less than the maximum allowable page size. |
Prefer: include-unknown-enum-members | Enables evolveable enum values beyond the sentinel value. See Best Practices for more information. Optional. |
Request body
Don't 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 example shows a request to get the basic details from a callRecord.
GET https://graph.microsoft.com/v1.0/communications/callRecords/{id}
Response
The following example shows 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 example shows a 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 example shows the response. If the sessions list is truncated, a sessions@odata.nextLink
value will be provided to retrieve the next page of sessions. The maximum 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",
"isTest": false,
"caller": {
"@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
"name": "machineName_2",
"cpuName": "Intel(R) Xeon(R) Platinum 8272CL CPU @ 2.60GHz",
"cpuCoresCount": 2,
"cpuProcessorSpeedInMhz": 2594,
"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",
"name": "machineName_4",
"cpuName": "Intel(R) Xeon(R) CPU E5-2673 v4 @ 2.30GHz",
"cpuCoresCount": 8,
"cpuProcessorSpeedInMhz": 2295,
"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",
"name": "machineName_4",
"cpuName": "Intel(R) Xeon(R) CPU E5-2673 v4 @ 2.30GHz",
"cpuCoresCount": 8,
"cpuProcessorSpeedInMhz": 2295,
"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",
"name": "machineName_6",
"cpuName": "Intel(R) Xeon(R) CPU E5-2673 v4 @ 2.30GHz",
"cpuCoresCount": 8,
"cpuProcessorSpeedInMhz": 2295,
"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",
"rmsFreezeDuration": null,
"averageFreezeDuration": null,
"isAudioForwardErrorCorrectionUsed": false
},
{
"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",
"rmsFreezeDuration": null,
"averageFreezeDuration": null,
"isAudioForwardErrorCorrectionUsed": null
}
]
}
]
}
]
}
],
"sessions@odata.nextLink": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/sessions?$expand=segments&$skiptoken=abc"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for