予定参加者の取得

本インターフェースを呼び出して、予定参加者のリストを取得します。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

名前	タイプ	必須	説明
userId	String	必須	本リクエストのリソースが所属するユーザーの unionId。 - 社内アプリおよびサードパーティ社内アプリの場合は、ユーザー詳細の照会インターフェースを呼び出して unionid パラメータの値を取得します。 - サードパーティ個人アプリの場合は、ユーザーの連絡先プロフィールを取得インターフェースを呼び出して unionId パラメータの値を取得します。
calendarId	String	必須	予定が所属するカレンダー ID。 primary で統一されており、ユーザーのメインカレンダーを表します。
eventId	String	必須	予定 ID。予定リストの照会インターフェースを呼び出して id パラメータの値を取得できます。

クエリパラメータ

名前	タイプ	必須	説明
maxResults	Integer	任意	最大返却レコード数。デフォルトは 100、最大値は 500 です。
nextToken	String	任意	ページングカーソル。 1 つのクエリ条件で一度にすべての結果を返せない場合、ページングトークンが返されます。次回のクエリでこのトークンを付与すると後続のデータが返却され、ページングトークンが null になるとすべてのデータの照会が完了したことを示します。

リクエスト例

HTTP

GET /v1.0/calendar/users/user456/calendars/primary/events/cnNTbW1Ybxxx/attendees?maxResults=100&nextToken=0 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BExxx
Content-Type:application/json

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();
        ListAttendeesHeaders listAttendeesHeaders = new ListAttendeesHeaders();
        listAttendeesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        ListAttendeesRequest listAttendeesRequest = new ListAttendeesRequest()
                .setMaxResults(100)
                .setNextToken("0");
        try {
            client.listAttendeesWithOptions("user456", "primary", "cnNTbW1Ybxxx", listAttendeesRequest, listAttendeesHeaders, 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()
        list_attendees_headers = dingtalkcalendar__1__0_models.ListAttendeesHeaders()
        list_attendees_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_attendees_request = dingtalkcalendar__1__0_models.ListAttendeesRequest(
            max_results=100,
            next_token='0'
        )
        try:
            client.list_attendees_with_options('user456', 'primary', 'cnNTbW1Ybxxx', list_attendees_request, list_attendees_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()
        list_attendees_headers = dingtalkcalendar__1__0_models.ListAttendeesHeaders()
        list_attendees_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_attendees_request = dingtalkcalendar__1__0_models.ListAttendeesRequest(
            max_results=100,
            next_token='0'
        )
        try:
            await client.list_attendees_with_options_async('user456', 'primary', 'cnNTbW1Ybxxx', list_attendees_request, list_attendees_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\ListAttendeesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\ListAttendeesRequest;
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();
        $listAttendeesHeaders = new ListAttendeesHeaders([]);
        $listAttendeesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listAttendeesRequest = new ListAttendeesRequest([
            "maxResults" => 100,
            "nextToken" => "0"
        ]);
        try {
            $client->listAttendeesWithOptions("user456", "primary", "cnNTbW1Ybxxx", $listAttendeesRequest, $listAttendeesHeaders, 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
  }

  listAttendeesHeaders := &dingtalkcalendar_1_0.ListAttendeesHeaders{}
  listAttendeesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listAttendeesRequest := &dingtalkcalendar_1_0.ListAttendeesRequest{
    MaxResults: tea.Int32(100),
    NextToken: tea.String("0"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListAttendeesWithOptions(tea.String("user456"), tea.String("primary"), tea.String("cnNTbW1Ybxxx"), listAttendeesRequest, listAttendeesHeaders, &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 listAttendeesHeaders = new $dingtalkcalendar_1_0.ListAttendeesHeaders({ });
    listAttendeesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let listAttendeesRequest = new $dingtalkcalendar_1_0.ListAttendeesRequest({
      maxResults: 100,
      nextToken: "0",
    });
    try {
      await client.listAttendeesWithOptions("user456", "primary", "cnNTbW1Ybxxx", listAttendeesRequest, listAttendeesHeaders, 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.ListAttendeesHeaders listAttendeesHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.ListAttendeesHeaders();
            listAttendeesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.ListAttendeesRequest listAttendeesRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.ListAttendeesRequest
            {
                MaxResults = 100,
                NextToken = "0",
            };
            try
            {
                client.ListAttendeesWithOptions("user456", "primary", "cnNTbW1Ybxxx", listAttendeesRequest, listAttendeesHeaders, 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::ListAttendeesHeaders> listAttendeesHeaders = make_shared<Alibabacloud_Dingtalkcalendar_1_0::ListAttendeesHeaders>();
  listAttendeesHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkcalendar_1_0::ListAttendeesRequest> listAttendeesRequest = make_shared<Alibabacloud_Dingtalkcalendar_1_0::ListAttendeesRequest>(map<string, boost::any>({
    {"maxResults", boost::any(100)},
    {"nextToken", boost::any(string("0"))}
  }));
  try {
    client->listAttendeesWithOptions(make_shared<string>("user456"), make_shared<string>("primary"), make_shared<string>("cnNTbW1Ybxxx"), listAttendeesRequest, listAttendeesHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
    }
  }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
nextToken	String	ページングトークン。
attendees	Array	予定参加者リスト。
id	String	ユーザーの unionId。
displayName	String	ユーザー名。
responseStatus	String	レスポンスステータス。 - needsAction（デフォルト）：未操作 - accepted：承認 - declined：辞退 - tentative：保留付き承認
self	Boolean	現在のユーザーかどうか。 - true：はい - false：いいえ
isOptional	Boolean	任意参加者かどうか。 - true：はい - false：いいえ

レスポンスボディ例

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

{
  "nextToken" : "ajshxxxx",
  "attendees" : [ {
    "id" : "user123",
    "displayName" : "佐藤花子",
    "responseStatus" : "accepted",
    "self" : false,
    "isOptional" : false
  } ]
}

エラーコード

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

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidParameter.event.calendarId	CalendarId cannot be blank	カレンダー ID は空にできません
400	invalidParameter.event.eventId	eventId cannot be blank	予定 ID は空にできません
400	invalidParameter.subscribed.invalid	Subscribed calendar not support this method	購読カレンダーは本メソッドをサポートしていません
400	invalidParameter.maxResults	maxResults size must within range [0,500]	maxResults が範囲を超えています
400	invalidParameter	forwardErrorMessage	パラメータエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード