会議室のフリー / ビジー情報を取得

本インターフェースを呼び出して、指定した会議室のフリー / ビジー情報を取得します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/calendar/users/{userId}/meetingRooms/schedules/query`
HTTP Method	POST
サポートされるアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要な権限	permission-Calendar.Event.Read-カレンダーアプリにおける予定の読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェース呼び出し時のアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合は、社内アプリの access_token を取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリで権限付与された企業の access_token を取得インターフェースを呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
userId	String	はい	本リクエストのリソースが属するユーザーの unionId。ユーザー詳細を照会インターフェースを呼び出して取得できます。

リクエストボディ

名前	タイプ	必須	説明
roomIds	Array of String	はい	照会対象の会議室 roomId リスト。会議室リストを照会インターフェースを呼び出して取得できます。5 件以内を推奨します。
startTime	String	はい	照会開始時刻（iso8601 形式）。例：2022-07-29T14:55Z。
endTime	String	はい	照会終了時刻（iso8601 形式）。例：2022-07-29T14:55Z。

リクエスト例

HTTP

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

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウント Client を初期化
     * @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<String> 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 = "<your access token>";
        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 には code と message 属性が含まれ、問題の切り分けに役立ちます
            }

        } 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 には code と message 属性が含まれ、問題の切り分けに役立ちます
            }

        }        
    }
}

Python

# -*- 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:
        """
        トークンを使用してアカウント Client を初期化
        @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 = '<your 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 には code と message 属性が含まれ、問題の切り分けに役立ちます
                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 = '<your 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 には code と message 属性が含まれ、問題の切り分けに役立ちます
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\GetMeetingRoomsScheduleHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\GetMeetingRoomsScheduleRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウント Client を初期化
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->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 = "<your access token>";
        $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 には code と message 属性が含まれ、問題の切り分けに役立ちます
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

// 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"
)

/**
 * トークンを使用してアカウント Client を初期化
 * @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("<your access token>")
  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 には code と message 属性が含まれ、問題の切り分けに役立ちます
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

// 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 {

  /**
   * トークンを使用してアカウント Client を初期化
   * @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<void> {
    let client = Client.createClient();
    let getMeetingRoomsScheduleHeaders = new $dingtalkcalendar_1_0.GetMeetingRoomsScheduleHeaders({ });
    getMeetingRoomsScheduleHeaders.xAcsDingtalkAccessToken = "<your access token>";
    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 には code と message 属性が含まれ、問題の切り分けに役立ちます
      }

    }    
  }

}

Client.main(process.argv.slice(2));

// 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 
    {

        /**
         * トークンを使用してアカウント Client を初期化
         * @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 = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleRequest getMeetingRoomsScheduleRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleRequest
            {
                RoomIds = new List<string>
                {
                    "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 には code と message 属性が含まれ、問題の切り分けに役立ちます
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれ、問題の切り分けに役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
scheduleInformation	Array	会議室のフリー / ビジー情報リスト。
roomId	String	会議室の roomId。
error	String	エラー情報。
scheduleItems	Array	フリー / ビジー情報リスト。このフィールドが空で返された場合、当該会議室は指定期間内に空き状態であることを示します。
status	String	フリー / ビジーステータス。 - BUSY：ビジー - TENTATIVE：承認中
eventId	String	予定 ID。
organizer	Object	予定の主催者情報。
id	String	主催者の unionId。
start	Object	予定開始時刻に関する情報。
dateTime	String	予定開始時刻（iso8601 形式）。例：2022-07-29T14:55Z。
timeZone	String	タイムゾーン名。IANA Time Zone Database 標準を使用します。例：`Asia/Shanghai`。終日予定のタイムゾーンは UTC 固定、終日以外の予定のタイムゾーンはデフォルトで `Asia/Shanghai` です。
end	Object	予定終了時刻に関する情報。
dateTime	String	予定終了時刻（iso8601 形式）。例：2022-07-29T14:55Z。
timeZone	String	タイムゾーン名。IANA Time Zone Database 標準を使用します。例：`Asia/Shanghai`。終日予定のタイムゾーンは UTC 固定、終日以外の予定のタイムゾーンはデフォルトで `Asia/Shanghai` です。

レスポンスボディ例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "scheduleInformation" : [ {
    "roomId" : "4002f89xxxxx",
    "error" : "権限がありません",
    "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"
      }
    } ]
  } ]
}

エラーコード

本インターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージに基づきグローバルエラーコードドキュメントで解決方法を確認できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidParameter	forwardErrorMessage	パラメータエラー
400	invalidParameter	query ids cannot be empty	照会 ID は空にできません
400	invalidParameter	Cannot get schedule information for more than limit.	照会件数が上限を超えています
400	invalidParameter	Cannot query schedule for more than 90 days.	照会日数が上限を超えています
400	invalidParameter	roomId invalid	roomId が不正です
400	meetingRoomNotAvailable	room busy	会議室はすでに使用中です

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

会議室のフリー / ビジー情報を取得

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード