ユーザーのフリー/ビジー情報を取得する

本インターフェースを呼び出して、指定したユーザーリストの指定期間内のフリー/ビジー情報を照会します。

リクエスト

基本情報

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

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	必須	本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合は、社内アプリの access_token を取得するインターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリの認可企業の access_token を取得するインターフェースを呼び出して取得します。 - サードパーティ個人アプリの場合は、ユーザートークンを取得するインターフェースを呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
userId	String	必須	本リクエストのリソースが帰属するユーザーの unionId。 - 社内アプリおよびサードパーティ社内アプリの場合は、ユーザー詳細を照会するインターフェースを呼び出して unionid パラメータの値を取得します。 - サードパーティ個人アプリの場合は、ユーザーの連絡先プロフィールを取得するインターフェースを呼び出して unionId パラメータの値を取得します。

リクエストボディ

名前	タイプ	必須	説明
userIds	Array of String	必須	照会対象ユーザーの unionId。 - 社内アプリおよびサードパーティ社内アプリの場合は、ユーザー詳細を照会するインターフェースを呼び出して unionid パラメータの値を取得します。 - サードパーティ個人アプリの場合は、ユーザーの連絡先プロフィールを取得するインターフェースを呼び出して unionId パラメータの値を取得します。ユーザーリストの最大長は 20 です。
startTime	String	必須	照会の開始時刻。
endTime	String	必須	照会の終了時刻。

リクエスト例

HTTP

POST /v1.0/calendar/users/iiiP35sJaxx/getSchedule HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:dd43888xxx
Content-Type:application/json

{
  "userIds" : [ "iiiP35sJaxxx" ],
  "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.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkcalendar_1_0.*;
import com.aliyun.dingtalkcalendar_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * トークンを使用してアカウント Client を初期化します
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkcalendar_1_0.Client createClient() throws Exception {
        Config config = new 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();
        GetScheduleHeaders getScheduleHeaders = new GetScheduleHeaders();
        getScheduleHeaders.xAcsDingtalkAccessToken = "<your access token>";
        GetScheduleRequest getScheduleRequest = new GetScheduleRequest()
                .setUserIds(java.util.Arrays.asList(
                    "iiiP35sJaxxx"
                ))
                .setStartTime("2020-01-01T10:15:30+08:00")
                .setEndTime("2020-01-01T10:15:30+08:00");
        try {
            client.getScheduleWithOptions("iiiP35sJaxx", getScheduleRequest, getScheduleHeaders, new 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_schedule_headers = dingtalkcalendar__1__0_models.GetScheduleHeaders()
        get_schedule_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_schedule_request = dingtalkcalendar__1__0_models.GetScheduleRequest(
            user_ids=[
                'iiiP35sJaxxx'
            ],
            start_time='2020-01-01T10:15:30+08:00',
            end_time='2020-01-01T10:15:30+08:00'
        )
        try:
            client.get_schedule_with_options('iiiP35sJaxx', get_schedule_request, get_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_schedule_headers = dingtalkcalendar__1__0_models.GetScheduleHeaders()
        get_schedule_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_schedule_request = dingtalkcalendar__1__0_models.GetScheduleRequest(
            user_ids=[
                'iiiP35sJaxxx'
            ],
            start_time='2020-01-01T10:15:30+08:00',
            end_time='2020-01-01T10:15:30+08:00'
        )
        try:
            await client.get_schedule_with_options_async('iiiP35sJaxx', get_schedule_request, get_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\GetScheduleHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\GetScheduleRequest;
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();
        $getScheduleHeaders = new GetScheduleHeaders([]);
        $getScheduleHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getScheduleRequest = new GetScheduleRequest([
            "userIds" => [
                "iiiP35sJaxxx"
            ],
            "startTime" => "2020-01-01T10:15:30+08:00",
            "endTime" => "2020-01-01T10:15:30+08:00"
        ]);
        try {
            $client->getScheduleWithOptions("iiiP35sJaxx", $getScheduleRequest, $getScheduleHeaders, 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/service"
  dingtalkcalendar_1_0  "github.com/alibabacloud-go/dingtalk/calendar_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/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
  }

  getScheduleHeaders := &dingtalkcalendar_1_0.GetScheduleHeaders{}
  getScheduleHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getScheduleRequest := &dingtalkcalendar_1_0.GetScheduleRequest{
    UserIds: []*string{tea.String("iiiP35sJaxxx")},
    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.GetScheduleWithOptions(tea.String("iiiP35sJaxx"), getScheduleRequest, getScheduleHeaders, &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 getScheduleHeaders = new $dingtalkcalendar_1_0.GetScheduleHeaders({ });
    getScheduleHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getScheduleRequest = new $dingtalkcalendar_1_0.GetScheduleRequest({
      userIds: [
        "iiiP35sJaxxx"
      ],
      startTime: "2020-01-01T10:15:30+08:00",
      endTime: "2020-01-01T10:15:30+08:00",
    });
    try {
      await client.getScheduleWithOptions("iiiP35sJaxx", getScheduleRequest, getScheduleHeaders, 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.GetScheduleHeaders getScheduleHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetScheduleHeaders();
            getScheduleHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetScheduleRequest getScheduleRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetScheduleRequest
            {
                UserIds = new List<string>
                {
                    "iiiP35sJaxxx"
                },
                StartTime = "2020-01-01T10:15:30+08:00",
                EndTime = "2020-01-01T10:15:30+08:00",
            };
            try
            {
                client.GetScheduleWithOptions("iiiP35sJaxx", getScheduleRequest, getScheduleHeaders, 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 属性が含まれ、開発者が問題の特定に役立ちます
                }
            }
        }

    }
}

// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkcalendar__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkcalendar_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkcalendar_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkcalendar_1_0::Client> client = make_shared<Alibabacloud_Dingtalkcalendar_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkcalendar_1_0::GetScheduleHeaders> getScheduleHeaders = make_shared<Alibabacloud_Dingtalkcalendar_1_0::GetScheduleHeaders>();
  getScheduleHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkcalendar_1_0::GetScheduleRequest> getScheduleRequest = make_shared<Alibabacloud_Dingtalkcalendar_1_0::GetScheduleRequest>(map<string, boost::any>({
    {"userIds", boost::any(vector<string>({
      "iiiP35sJaxxx"
    }))},
    {"startTime", boost::any(string("2020-01-01T10:15:30+08:00"))},
    {"endTime", boost::any(string("2020-01-01T10:15:30+08:00"))}
  }));
  try {
    client->getScheduleWithOptions(make_shared<string>("iiiP35sJaxx"), getScheduleRequest, getScheduleHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err には code と message 属性が含まれ、開発者が問題の特定に役立ちます
    }
  }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
scheduleInformation	Array	ユーザーのフリー/ビジー情報。
userId	String	照会対象ユーザーの unionId。
error	String	エラー情報。
scheduleItems	Array	フリー/ビジー情報リスト。
status	String	ステータス。 - BUSY：ビジー - TENTATIVE：保留ビジー
start	Object	予定の開始時刻。
date	String	予定の開始日付。フォーマット：`yyyy-MM-dd`。
dateTime	String	予定の開始時刻。`ISO-8601` の `date-time` フォーマット。
timeZone	String	タイムゾーン名。IANA Time Zone Database 標準を使用します。例：`Asia/Shanghai`。終日予定のタイムゾーンは UTC で固定されており、終日以外の予定のタイムゾーンはデフォルトで `Asia/Shanghai` です。
end	Object	予定の終了時刻。
date	String	予定の終了日付。フォーマット：`yyyy-MM-dd`。
dateTime	String	予定の終了時刻。`ISO-8601` の `date-time` フォーマット。
timeZone	String	タイムゾーン名。IANA Time Zone Database 標準を使用します。例：`Asia/Shanghai`。終日予定のタイムゾーンは UTC で固定されており、終日以外の予定のタイムゾーンはデフォルトで `Asia/Shanghai` です。

レスポンスボディ例

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

{
  "scheduleInformation" : [ {
    "userId" : "iiiP35sJadxxx",
    "error" : "権限がありません",
    "scheduleItems" : [ {
      "status" : "BUSY",
      "start" : {
        "date" : "2020-01-01",
        "dateTime" : "2020-01-01T10:15:30+08:00",
        "timeZone" : "Asia/Shanghai"
      },
      "end" : {
        "date" : "2020-01-01",
        "dateTime" : "2020-01-01T10:15:30+08:00",
        "timeZone" : "Asia/Shanghai"
      }
    } ]
  } ]
}

エラーコード

本インターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策をご確認ください。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramIllegal	PARAM ILLEGAL	パラメータエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ユーザーのフリー/ビジー情報を取得する

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード