> ## Documentation Index > Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt > Use this file to discover all available pages before exploring further. # Get the free/busy information of a room > Call this API to get the free/busy information of a specified meeting room, used to check availability before booking. Call this API to get the free/busy information of a specified room. ## Request ### Basic information | Field | Value | | -------------------- | ----------------------------------------------------------------------------------- | | HTTP URL | `https://api.dingtalk.io/v1.0/calendar/users/{userId}/meetingRooms/schedules/query` | | HTTP Method | POST | | Supported app types | appType-Internal app　appType-Third-party enterprise app | | Required permissions | permission-Calendar.Event.Read-Read permission for events in the Calendar app | ### Request headers | Name | Type | Required | Description | | --------------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#) API. - For a third-party enterprise app, call the [Get the access token of an organization authorized to a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API. | ### Path parameters | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | userId | String | Yes | The unionId of the user who owns the resource for this request. Call the [Query user details](/open/development/query-user-details#) API to obtain it. | ### Request body | Name | Type | Required | Description | | --------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | roomIds | Array of String | Yes | The list of roomIds to query. Call the [Query the room list](/open/development/check-the-meeting-room-list#) API to obtain them. We recommend that the number of roomIds does not exceed 5. | | startTime | String | Yes | The start time of the query, in ISO 8601 format. Example: 2022-07-29T14:55Z. | | endTime | String | Yes | The end time of the query, in ISO 8601 format. Example: 2022-07-29T14:55Z. | ### Request example HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v1.0/calendar/users/U5KPxxxxx/meetingRooms/schedules/query HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:xxxxx Content-Type:application/json { "roomIds" : [ "4002xxxxx" ], "startTime" : "2020-01-01T10:15:30+08:00", "endTime" : "2020-01-01T10:15:30+08:00" } ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package com.aliyun.sample; import com.aliyun.tea.*; public class Sample { /** * Initialize the account Client with a Token * @return Client * @throws Exception */ public static com.aliyun.dingtalkcalendar_1_0.Client createClient() throws Exception { com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config(); config.protocol = "https"; config.regionId = "central"; return new com.aliyun.dingtalkcalendar_1_0.Client(config); } public static void main(String[] args_) throws Exception { java.util.List args = java.util.Arrays.asList(args_); com.aliyun.dingtalkcalendar_1_0.Client client = Sample.createClient(); com.aliyun.dingtalkcalendar_1_0.models.GetMeetingRoomsScheduleHeaders getMeetingRoomsScheduleHeaders = new com.aliyun.dingtalkcalendar_1_0.models.GetMeetingRoomsScheduleHeaders(); getMeetingRoomsScheduleHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkcalendar_1_0.models.GetMeetingRoomsScheduleRequest getMeetingRoomsScheduleRequest = new com.aliyun.dingtalkcalendar_1_0.models.GetMeetingRoomsScheduleRequest() .setRoomIds(java.util.Arrays.asList( "4002xxxxx" )) .setStartTime("2020-01-01T10:15:30+08:00") .setEndTime("2020-01-01T10:15:30+08:00"); try { client.getMeetingRoomsScheduleWithOptions("U5KPxxxxx", getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, new com.aliyun.teautil.models.RuntimeOptions()); } catch (TeaException err) { if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) { // err contains code and message attributes to help locate the issue } } catch (Exception _err) { TeaException err = new TeaException(_err.getMessage(), _err); if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) { // err contains code and message attributes to help locate the issue } } } } ``` Python ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- coding: utf-8 -*- # This file is auto-generated, don't edit it. Thanks. import sys from typing import List from alibabacloud_dingtalk.calendar_1_0.client import Client as dingtalkcalendar_1_0Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_dingtalk.calendar_1_0 import models as dingtalkcalendar__1__0_models from alibabacloud_tea_util import models as util_models from alibabacloud_tea_util.client import Client as UtilClient class Sample: def __init__(self): pass @staticmethod def create_client() -> dingtalkcalendar_1_0Client: """ Initialize the account Client with a Token @return: Client @throws Exception """ config = open_api_models.Config() config.protocol = 'https' config.region_id = 'central' return dingtalkcalendar_1_0Client(config) @staticmethod def main( args: List[str], ) -> None: client = Sample.create_client() get_meeting_rooms_schedule_headers = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleHeaders() get_meeting_rooms_schedule_headers.x_acs_dingtalk_access_token = '' get_meeting_rooms_schedule_request = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleRequest( room_ids=[ '4002xxxxx' ], start_time='2020-01-01T10:15:30+08:00', end_time='2020-01-01T10:15:30+08:00' ) try: client.get_meeting_rooms_schedule_with_options('U5KPxxxxx', get_meeting_rooms_schedule_request, get_meeting_rooms_schedule_headers, util_models.RuntimeOptions()) except Exception as err: if not UtilClient.empty(err.code) and not UtilClient.empty(err.message): # err contains code and message attributes to help locate the issue pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() get_meeting_rooms_schedule_headers = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleHeaders() get_meeting_rooms_schedule_headers.x_acs_dingtalk_access_token = '' get_meeting_rooms_schedule_request = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleRequest( room_ids=[ '4002xxxxx' ], start_time='2020-01-01T10:15:30+08:00', end_time='2020-01-01T10:15:30+08:00' ) try: await client.get_meeting_rooms_schedule_with_options_async('U5KPxxxxx', get_meeting_rooms_schedule_request, get_meeting_rooms_schedule_headers, util_models.RuntimeOptions()) except Exception as err: if not UtilClient.empty(err.code) and not UtilClient.empty(err.message): # err contains code and message attributes to help locate the issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $getMeetingRoomsScheduleHeaders = new GetMeetingRoomsScheduleHeaders([]); $getMeetingRoomsScheduleHeaders->xAcsDingtalkAccessToken = ""; $getMeetingRoomsScheduleRequest = new GetMeetingRoomsScheduleRequest([ "roomIds" => [ "4002xxxxx" ], "startTime" => "2020-01-01T10:15:30+08:00", "endTime" => "2020-01-01T10:15:30+08:00" ]); try { $client->getMeetingRoomsScheduleWithOptions("U5KPxxxxx", $getMeetingRoomsScheduleRequest, $getMeetingRoomsScheduleHeaders, new RuntimeOptions([])); } catch (Exception $err) { if (!($err instanceof TeaError)) { $err = new TeaError([], $err->getMessage(), $err->getCode(), $err); } if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) { // err contains code and message attributes to help locate the issue } } } } $path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php'; if (file_exists($path)) { require_once $path; } Sample::main(array_slice($argv, 1)); ``` Go ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package main import ( "os" util "github.com/alibabacloud-go/tea-utils/v2/service" dingtalkcalendar_1_0 "github.com/alibabacloud-go/dingtalk/calendar_1_0" openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client" "github.com/alibabacloud-go/tea/tea" ) /** * Initialize the account Client with a Token * @return Client * @throws Exception */ func CreateClient () (_result *dingtalkcalendar_1_0.Client, _err error) { config := &openapi.Config{} config.Protocol = tea.String("https") config.RegionId = tea.String("central") _result = &dingtalkcalendar_1_0.Client{} _result, _err = dingtalkcalendar_1_0.NewClient(config) return _result, _err } func _main (args []*string) (_err error) { client, _err := CreateClient() if _err != nil { return _err } getMeetingRoomsScheduleHeaders := &dingtalkcalendar_1_0.GetMeetingRoomsScheduleHeaders{} getMeetingRoomsScheduleHeaders.XAcsDingtalkAccessToken = tea.String("") getMeetingRoomsScheduleRequest := &dingtalkcalendar_1_0.GetMeetingRoomsScheduleRequest{ RoomIds: []*string{tea.String("4002xxxxx")}, StartTime: tea.String("2020-01-01T10:15:30+08:00"), EndTime: tea.String("2020-01-01T10:15:30+08:00"), } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.GetMeetingRoomsScheduleWithOptions(tea.String("U5KPxxxxx"), getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, &util.RuntimeOptions{}) if _err != nil { return _err } return nil }() if tryErr != nil { var err = &tea.SDKError{} if _t, ok := tryErr.(*tea.SDKError); ok { err = _t } else { err.Message = tea.String(tryErr.Error()) } if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) { // err contains code and message attributes to help locate the issue } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it import Util, * as $Util from '@alicloud/tea-util'; import dingtalkcalendar_1_0, * as $dingtalkcalendar_1_0 from '@alicloud/dingtalk/calendar_1_0'; import OpenApi, * as $OpenApi from '@alicloud/openapi-client'; import * as $tea from '@alicloud/tea-typescript'; export default class Client { /** * Initialize the account Client with a Token * @return Client * @throws Exception */ static createClient(): dingtalkcalendar_1_0 { let config = new $OpenApi.Config({ }); config.protocol = "https"; config.regionId = "central"; return new dingtalkcalendar_1_0(config); } static async main(args: string[]): Promise { let client = Client.createClient(); let getMeetingRoomsScheduleHeaders = new $dingtalkcalendar_1_0.GetMeetingRoomsScheduleHeaders({ }); getMeetingRoomsScheduleHeaders.xAcsDingtalkAccessToken = ""; let getMeetingRoomsScheduleRequest = new $dingtalkcalendar_1_0.GetMeetingRoomsScheduleRequest({ roomIds: [ "4002xxxxx" ], startTime: "2020-01-01T10:15:30+08:00", endTime: "2020-01-01T10:15:30+08:00", }); try { await client.getMeetingRoomsScheduleWithOptions("U5KPxxxxx", getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err contains code and message attributes to help locate the issue } } } } Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. using System; using System.Collections; using System.Collections.Generic; using System.IO; using System.Threading.Tasks; using Tea; using Tea.Utils; namespace AlibabaCloud.SDK.Sample { public class Sample { /** * Initialize the account Client with a Token * @return Client * @throws Exception */ public static AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client CreateClient() { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config(); config.Protocol = "https"; config.RegionId = "central"; return new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client(config); } public static void Main(string[] args) { AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client client = CreateClient(); AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleHeaders getMeetingRoomsScheduleHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleHeaders(); getMeetingRoomsScheduleHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleRequest getMeetingRoomsScheduleRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleRequest { RoomIds = new List { "4002xxxxx" }, StartTime = "2020-01-01T10:15:30+08:00", EndTime = "2020-01-01T10:15:30+08:00", }; try { client.GetMeetingRoomsScheduleWithOptions("U5KPxxxxx", getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions()); } catch (TeaException err) { if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains code and message attributes to help locate the issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains code and message attributes to help locate the issue } } } } } ``` ## Response ### Response body | Name | Type | Description | | ------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | scheduleInformation | Array | The free/busy information list of the rooms. | | roomId | String | The roomId of the room. | | error | String | The error message. | | scheduleItems | Array | The free/busy information list. If this field returns empty, the room is free during the specified time range. | | status | String | The free/busy status. - **BUSY**: Busy - **TENTATIVE**: Pending approval | | eventId | String | The event ID. | | organizer | Object | The information about the event organizer. | | id | String | The unionId of the organizer. | | start | Object | The information about the event start time. | | dateTime | String | The event start time, in ISO 8601 format. Example: 2022-07-29T14:55Z. | | timeZone | String | The time zone name, following the **IANA Time Zone Database** standard. Example: `Asia/Shanghai`. For all-day events, the time zone is fixed to UTC. For non-all-day events, the default time zone is `Asia/Shanghai`. | | end | Object | The information about the event end time. | | dateTime | String | The event end time, in ISO 8601 format. Example: 2022-07-29T14:55Z. | | timeZone | String | The time zone name, following the **IANA Time Zone Database** standard. Example: `Asia/Shanghai`. For all-day events, the time zone is fixed to UTC. For non-all-day events, the default time zone is `Asia/Shanghai`. | ### Response body example ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "scheduleInformation" : [ { "roomId" : "4002f89xxxxx", "error" : "No permission", "scheduleItems" : [ { "status" : "BUSY", "eventId" : "UzZvxxxxx", "organizer" : { "id" : "WWxlK8xxxxx" }, "start" : { "dateTime" : "2020-01-01T10:15:30+08:00", "timeZone" : "Asia/Shanghai" }, "end" : { "dateTime" : "2020-01-02T10:15:30+08:00", "timeZone" : "Asia/Shanghai" } } ] } ] } ``` ### Error codes If the API call fails, find a solution by error message in the [Global error codes](/open/development/server-api-error-codes-1) document. | HttpCode | Error code | Error message | Description | | -------- | ----------------------- | ---------------------------------------------------- | --------------------------------------- | | 400 | invalidParameter | forwardErrorMessage | Invalid parameter | | 400 | invalidParameter | query ids cannot be empty | The query IDs cannot be empty | | 400 | invalidParameter | Cannot get schedule information for more than limit. | The number of queries exceeds the limit | | 400 | invalidParameter | Cannot query schedule for more than 90 days. | The query duration exceeds the limit | | 400 | invalidParameter | roomId invalid | The roomId is invalid | | 400 | meetingRoomNotAvailable | room busy | The room is already occupied |