callRecord: getDirectRoutingCalls
Namespace: microsoft.graph.callRecords
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Get a log of direct routing calls as a collection of directRoutingLogRow entries.
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/getDirectRoutingCalls(fromDateTime={fromDateTime},toDateTime={toDateTime})
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Function parameters
In the request URL, provide the following query parameters with values. The following table shows the parameters that can be used with this function.
Parameter | Type | Description |
---|---|---|
fromDateTime | DateTimeOffset | Start of time range to query. UTC, inclusive. Time range is based on the call start time. |
toDateTime | DateTimeOffset | End of time range to query. UTC, exclusive. |
Response
If successful, this function returns a 200 OK
response code and a collection of directRoutingLogRow entries in the response body.
If there are more than 1,000 entries in the date range, the body also includes an @odata.nextLink
with a URL to query the next page of call entries. The last page in the date range doesn't have @odata.nextLink
. For more information, see paging Microsoft Graph data in your app.
Example
The following example shows how to get a collection of records for direct routing calls that occurred in the specified date range. The response includes "@odata.count": 1000
to enumerate the number of records in this first response, and @odata.nextLink
to get records beyond the first 1,000. For readability, the response shows only a collection of one record. Assume there are more than 1,000 calls in that date range.
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/communications/callRecords/getDirectRoutingCalls(fromDateTime=2019-11-01,toDateTime=2019-12-01)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.callRecords.directRoutingLogRow)",
"@odata.count": 1000,
"@odata.nextLink": "https://graph.microsoft.com/beta/communications/callRecords/getDirectRoutingCalls(fromDateTime=2019-11-01,toDateTime=2019-12-01)?$skip=1000",
"value": [
{
"id": "9e8bba57-dc14-533a-a7dd-f0da6575eed1",
"correlationId": "c98e1515-a937-4b81-b8a8-3992afde64e0",
"userId": "db03c14b-06eb-4189-939b-7cbf3a20ba27",
"userPrincipalName": "richard.malk@contoso.com",
"userDisplayName": "Richard Malk",
"startDateTime": "2019-11-01T00:00:25.105Z",
"endDateTime": "2019-11-01T00:00:30.105Z",
"inviteDateTime": "2019-11-01T00:00:21.949Z",
"failureDateTime": "0001-01-01T00:00:00Z",
"duration": 5,
"callType": "ByotIn",
"successfulCall": true,
"callerNumber": "+12345678***",
"calleeNumber": "+01234567***",
"mediaPathLocation": "USWE",
"signalingLocation": "EUNO",
"finalSipCode": 0,
"callEndSubReason": 540000,
"finalSipCodePhrase": "BYE",
"trunkFullyQualifiedDomainName": "tll-audiocodes01.adatum.biz",
"mediaBypassEnabled": false,
"userCountryCode": "US",
"otherPartyCountryCode": "US",
"transferorCorrelationId": "02d31a30-0abc-4154-964d-e23366e66feb",
"administrativeUnitInfos": [
{
"id": "639b616c-f164-4a6f-a933-24936b8eb210"
},
{
"id": "cc6ea167-4e92-4c2d-9391-85791e978006"
}
]
}
]
}
Related content
- Microsoft Teams direct routing usage report in the Microsoft Teams admin center.
- Health dashboard for direct routing in the Microsoft Teams admin center.
- Get log of PSTN calls.
- Get aggregated report of the audio conferencing dial-out.
- Get log of users who are blocked from making PSTN calls.
- Get log of sent/received SMS.