Outlook Calendar: Check User and Resource Free/Busy Availability
See more Outlook Calendar Examples
For Microsoft 365 organizational accounts, query users or resource mailboxes for the next eight hours using 30-minute slots. Replace the sample SMTP addresses. Delegated personal Microsoft accounts are not supported by getSchedule. Calendar access and tenant policy determine the details returned; successful HTTP status does not mean every schedule succeeded.
Check each schedule's error before reading its availability. Keep availabilityView as text: 0 is free or working elsewhere, 1 tentative, 2 busy, and 3 out of office. A free slot does not reserve a room or guarantee that it will remain free. Check the current getSchedule limits before batching larger address lists or time ranges, and split overly dense results if the service reports too many entries.
Delegated permission: Calendars.ReadBasic.
This example loads the delegated Graph token from the existing calendar authorization example. Use a work/school mailbox. An authorized app-only service can instead target /users/{id}/calendar/getSchedule.
HTTP methods can return false for an HTTP error as well as a connection failure. The code distinguishes those cases and checks the expected status before reading JSON. For 401, refresh the access token or authorize again; for 403, check permissions, mailbox access, and tenant policy. For 429, honor Retry-After before a bounded retry. Do not automatically repeat a write after an uncertain outcome. Keep detailed errors and calendar data private.
Chilkat PHP ActiveX Downloads
<?php
$success = 0;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$success = 0;
// Obtain a delegated Microsoft Graph token using the calendar authorization example.
// See Authorize Outlook Calendar with OAuth2 and PKCE.
$token = new COM("Chilkat.JsonObject");
$token->Strict = 1;
$success = $token->LoadFile('qa_data/tokens/outlookCalendar.json');
if ($success != 1) {
print 'Could not read the private calendar token cache.' . "\n";
exit;
}
if (($token->JsonTypeOf('access_token') != 1) or ($token->StringOfEquals('access_token','',1) == 1)) {
print 'Expected a nonempty access_token in the JSON.' . "\n";
exit;
}
$http = new COM("Chilkat.Http");
$http->AuthToken = $token->stringOf('access_token');
$http->RequireSslCertVerify = 1;
$http->FollowRedirects = 0;
$http->ConnectTimeout = 20;
$http->ReadTimeout = 30;
$http->SetRequestHeader('Accept','application/json');
$resp = new COM("Chilkat.HttpResponse");
$result = new COM("Chilkat.JsonObject");
$result->Strict = 1;
$http->SetRequestHeader('Prefer','outlook.timezone=\'UTC\', IdType=\'ImmutableId\'');
$body = new COM("Chilkat.JsonObject");
$body->UpdateString('schedules[0]','user@example.com');
$body->UpdateString('schedules[1]','room@example.com');
$body->UpdateInt('availabilityViewInterval',30);
$when = new COM("Chilkat.CkDateTime");
$success = $when->SetFromCurrentSystemTime();
if ($success != 1) {
print 'Could not get the window start.' . "\n";
exit;
}
$body->UpdateString('startTime.dateTime',$when->getAsIso8601('YYYY-MM-DDThh:mm:ss',0));
$body->UpdateString('startTime.timeZone','UTC');
$success = $when->AddSeconds(28800);
if ($success != 1) {
print 'Could not set the eight-hour window.' . "\n";
exit;
}
$body->UpdateString('endTime.dateTime',$when->getAsIso8601('YYYY-MM-DDThh:mm:ss',0));
$body->UpdateString('endTime.timeZone','UTC');
$success = $http->HttpJson('POST','https://graph.microsoft.com/v1.0/me/calendar/getSchedule',$body,'application/json',$resp);
// A false result can still include an HTTP error response.
if (($success != 1) and ($resp->StatusCode == 0)) {
print 'No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.' . "\n";
exit;
}
if ($resp->StatusCode != 200) {
print 'Unexpected HTTP status: ' . $resp->StatusCode . "\n";
print 'Request ID: ' . $resp->getHeaderField('request-id') . "\n";
if ($resp->StatusCode == 429) {
print 'Retry-After: ' . $resp->getHeaderField('Retry-After') . "\n";
}
if ($resp->StatusCode == 401) {
print 'Refresh the Graph access token or authorize again.' . "\n";
}
exit;
}
$success = $result->Load($resp->BodyStr);
if ($success != 1) {
print 'Expected a well-formed JSON response.' . "\n";
exit;
}
if ($result->JsonTypeOf('value') != 4) {
print 'Expected schedule results.' . "\n";
exit;
}
$i = 0;
while (($i < $result->SizeOfArray('value'))) {
$result->I = $i;
print 'Schedule: ' . $result->stringOf('value[i].scheduleId') . "\n";
if ($result->JsonTypeOf('value[i].error') == 3) {
print 'Schedule error: ' . $result->stringOf('value[i].error.responseCode') . "\n";
}
else {
// Keep the slot sequence as a string so leading zeroes are retained.
print 'Availability: ' . $result->stringOf('value[i].availabilityView') . "\n";
$j = 0;
while (($j < $result->SizeOfArray('value[i].scheduleItems'))) {
$result->J = $j;
print 'Status: ' . $result->stringOf('value[i].scheduleItems[j].status') . "\n";
print 'Start: ' . $result->stringOf('value[i].scheduleItems[j].start.dateTime') . "\n";
print 'End: ' . $result->stringOf('value[i].scheduleItems[j].end.dateTime') . "\n";
$j = $j + 1;
}
}
$i = $i + 1;
}
?>