callRecord: getPstnOnlineMeetingDialoutReport

Article
06/08/2023

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 aggregated report of usage and money spent for the audio conferencing dial-out service over a selected period as a collection of pstnOnlineMeetingDialoutReport entries. The report is aggregated by user, user location, destination context (domestic/international), and currency.

The report includes:

Cost: Communication credits spent over the selected period
Dial-out calls: Total number of dial-out calls over the selected period
Time of use: Total dial-out time (in seconds) over the selected period

This API is supported in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

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	CallRecord-PstnCalls.Read.All, CallRecords.Read.All

HTTP request

GET /communications/callRecords/getPstnOnlineMeetingDialoutReport(fromDateTime={fromDateTime},toDateTime={toDateTime})

Function parameters

In the request URL, provide the following query parameters with values.

Parameter	Type	Description
fromDateTime	DateTimeOffset	Start of time range to query. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Required.
toDateTime	DateTimeOffset	End of time range to query. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Required.

Important

The fromDateTime and toDateTime values can't be more than a date range of 90 days.

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a collection of microsoft.graph.callRecords.pstnOnlineMeetingDialoutReport entries in the response body.

If the function returns more than 1000 entries for the specified date range, the body also includes an @odata.nextLink with a URL to query the next page of entries. The last page in the date range doesn't have an @odata.nextLink. For more information, see paging Microsoft Graph data in your app.

Example

The following example shows how to get the aggregated report for the audio conferencing dial-out service over a specified date range. The response includes "@odata.count": 1000 to enumerate the number of records in this first response, and an @odata.nextLink to get records beyond the first 1000. For readability, the response object contains only a collection of one record.

Request

The following is an example of a request.

GET https://graph.microsoft.com/beta/communications/callRecords/getPstnOnlineMeetingDialoutReport(fromDateTime=2022-11-01,toDateTime=2022-12-01)


// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Communications.CallRecords.MicrosoftGraphCallRecordsGetPstnOnlineMeetingDialoutReportWithFromDateTimeWithToDateTime(DateTimeOffset.Parse("{fromDateTime}"),DateTimeOffset.Parse("{toDateTime}")).GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta communications call-records microsoft-graph-call-records-get-pstn-online-meeting-dialout-report-with-from-date-time-with-to-date-time get --from-date-time {from-date-time-id} --to-date-time {to-date-time-id}

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



fromDateTime , err := time.Parse(time.RFC3339, "{fromDateTime}")
toDateTime , err := time.Parse(time.RFC3339, "{toDateTime}")
microsoftGraphCallRecordsGetPstnOnlineMeetingDialoutReport, err := graphClient.Communications().CallRecords().MicrosoftGraphCallRecordsGetPstnOnlineMeetingDialoutReportWithFromDateTimeWithToDateTime(&fromDateTime, &toDateTime).Get(context.Background(), nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

CallRecordGetPstnOnlineMeetingDialoutReportCollectionPage getPstnOnlineMeetingDialoutReport = graphClient.communications().callRecords()
	.getPstnOnlineMeetingDialoutReport(CallRecordGetPstnOnlineMeetingDialoutReportParameterSet
		.newBuilder()
		.withFromDateTime("2022-11-01")
		.withToDateTime("2022-12-01")
		.build())
	.buildRequest()
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let getPstnOnlineMeetingDialoutReport = await client.api('/communications/callRecords/getPstnOnlineMeetingDialoutReport(fromDateTime=2022-11-01,toDateTime=2022-12-01)')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->communications()->callRecords()->microsoftGraphCallRecordsGetPstnOnlineMeetingDialoutReportWithFromDateTimeWithToDateTime(new \DateTime('{fromDateTime}'),new \DateTime('{toDateTime}'))->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.CloudCommunications

Get-MgBetaCommunicationCallRecordPstnOnlineMeetingDialoutReport

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)


result = await graph_client.communications.call_records.microsoft_graph_call_record_get_pstn_online_meeting_dialout_report(from_date_time={from_date_time},to_date_time={to_date_time}.get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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/beta/$metadata#Collection(microsoft.graph.callRecords.pstnOnlineMeetingDialoutReport)",
    "@odata.count": 1000,
    "@odata.nextLink": "https://graph.microsoft.com/beta/communications/callRecords/getPstnOnlineMeetingDialoutReport(fromDateTime=2022-11-01,toDateTime=2022-12-01)?$skip=1000",
    "value": [
        {
            "userId": "03de33bb-51df-40de-889a-61949faae24f",
            "userPrincipalName": "ruwini.perera@contoso.com",
            "userDisplayName": "Ruwini Perera",
            "usageLocation": "US",
            "destinationContext": "International",
            "currency": "USD",
            "totalCalls": 12,
            "totalCallCharge": 12.83,
            "totalCallSeconds": 723
        }
    ]
}

callRecord: getPstnOnlineMeetingDialoutReport

Permissions

HTTP request

Function parameters

Request headers

Request body

Response

Example

Request

Response

See also

Feedback

Additional resources

Additional resources