title | description | ms.localizationpriority | author | ms.subservice | doc_type |
---|---|---|---|---|---|
Get callRecord |
Retrieve the properties and relationships of callrecord object. |
medium |
mcm223 |
cloud-communications |
apiPageType |
Namespace: microsoft.graph.callRecords
Retrieve the properties and relationships of a callRecord object.
You can get the id of a callRecord in two ways:
- 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 remains available for 30 days. This API doesn't return call records older than 30 days, and requests for such records result in a 404 Not Found
response code.
[!INCLUDE national-cloud-support]
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.
[!INCLUDE permissions-table]
GET /communications/callRecords/{id}
Caution
- This API doesn't currently return a record of participants who stream a live event.
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 (participants_v2 or sessions and segments) in your results. For an example, see Get session and segment details. |
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 evolvable enum values beyond the sentinel value. For more information, see Best Practices for working with Microsoft Graph. Optional. |
Prefer: omit-values=nulls | Removes null or empty values from the response. Optional. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and a microsoft.graph.callRecords.callRecord object in the response body. A request for a call record older than 30 days returns a 404 Not Found
response code.
When a result set spans multiple pages, Microsoft Graph returns that page with an @odata.nextLink property in the response that contains a URL to the next page of results. If that property is present, continue making additional requests with the @odata.nextLink URL in each response, until all the results are returned. For more information, see Paging Microsoft Graph data in your app. Maximum page size: 130 entries for participants and 60 entries for sessions.
The following example shows how to get the basic details from a callRecord.
The following example shows a request.
GET https://graph.microsoft.com/v1.0/communications/callRecords/e523d2ed-2966-4b6b-925b-754a88034cc5
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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_v2@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/organizer_v2/$entity",
"organizer_v2": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"identity": {
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
},
"participants_v2@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2/$entity"
}
The following example shows how to get the full session and segment details from a callRecord.
The following example shows a request.
GET https://graph.microsoft.com/v1.0/communications/callRecords/e523d2ed-2966-4b6b-925b-754a88034cc5?$expand=sessions($expand=segments)
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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(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_v2@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/organizer_v2/$entity",
"organizer_v2": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"identity": {
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
},
"participants_v2@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2/$entity",
"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",
"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"
},
"associatedIdentity": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
"userPrincipalName": "abbie.wilkins@contoso.com"
}
},
"callee": {
"@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
"name": "machineName_4",
"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"
},
"associatedIdentity": {
"id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
"displayName": "Owen Franklin",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
"userPrincipalName": "owen.franklin@contoso.com"
},
"feedback": {
"rating": "poor"
}
},
"segments": [
{
"startDateTime": "2020-02-25T18:52:21.2169889Z",
"endDateTime": "2020-02-25T18:52:46.7640013Z",
"id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
"media": [
{
"label": "main-audio",
"callerNetwork": {
"ipAddress": "10.150.0.2",
"subnet": "10.150.0.0",
"linkSpeed": 54000000
},
"callerDevice": {
"captureDeviceName": "Default input device",
"renderDeviceName": "Default output device",
"receivedSignalLevel": -10
},
"streams": [
{
"streamId": "1504545584",
"streamDirection": "callerToCallee",
"averageAudioDegradation": null,
"averageJitter": "PT0.016S"
}
]
}
]
}
]
}
],
"sessions@odata.nextLink": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/sessions?$expand=segments&$skiptoken=abc"
}
The following example shows how to expand the full paginated participant list for a callRecord.
The following example shows a request.
GET https://graph.microsoft.com/v1.0/communications/callRecords/e523d2ed-2966-4b6b-925b-754a88034cc5?$expand=participants_v2
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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(participants_v2())/$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_v2@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/organizer_v2/$entity",
"organizer_v2": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"identity": {
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
}
}
},
"participants_v2@odata.context": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2/$entity",
"participants_v2@odata.nextLink": "https://graph.microsoft.com/v1.0/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2?$skiptoken=abc",
"participants_v2": [
{
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"identity": {
"user": {
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"displayName": "Abbie Wilkins",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
"userPrincipalName": "abbie.wilkins@contoso.com"
}
}
},
{
"id": "821809f5-0000-0000-0000-3b5136c0e777",
"identity": {
"user": {
"id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
"displayName": "Owen Franklin",
"tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
"userPrincipalName": "owen.franklin@contoso.com"
}
}
}
]
}