查询单个订阅日历详情 - DingTalk Help Center

调用本接口，查询订阅日历的详情信息。

请求

基本信息

字段	值
HTTP URL	`https://api.dingtalk.io/v1.0/calendar/users/{userId}/subscribedCalendars/{calendarId}`
HTTP Method	GET
支持的应用类型	appType-企业内部应用　appType-第三方企业应用　appType-第三方个人应用
权限要求	permission-Calendar.Calendar.Read-日历应用中日历读权限

请求头

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证，通过以下获取： - 企业内部应用，调用获取企业内部应用的accessToken接口获取。 - 第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。 - 第三方个人应用，调用获取用户token接口获取。

路径参数

名称	类型	是否必填	描述
userId	String	是	日历作者或者共同编辑人的unionId。 - 企业内部应用和第三方企业应用，调用查询用户详情接口获取unionid参数值。 - 第三方个人应用，调用获取用户通讯录个人信息接口获取unionId参数值。
calendarId	String	是	订阅日历id，可调用创建订阅日历接口获取calendarId参数值。

请求示例

HTTP

GET /v1.0/calendar/users/iiiP35sJadba8aBSgjrwPRKgiEiF/subscribedCalendars/M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT01
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 {

    /**
     * 使用 Token 初始化账号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();
        GetSubscribedCalendarHeaders getSubscribedCalendarHeaders = new GetSubscribedCalendarHeaders();
        getSubscribedCalendarHeaders.xAcsDingtalkAccessToken = "<your access token>";
        try {
            client.getSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", getSubscribedCalendarHeaders, 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:
        """
        使用 Token 初始化账号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_subscribed_calendar_headers = dingtalkcalendar__1__0_models.GetSubscribedCalendarHeaders()
        get_subscribed_calendar_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            client.get_subscribed_calendar_with_options('iiiP35sJadba8aBSgjrwPRKgiEiF', 'M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv', get_subscribed_calendar_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_subscribed_calendar_headers = dingtalkcalendar__1__0_models.GetSubscribedCalendarHeaders()
        get_subscribed_calendar_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            await client.get_subscribed_calendar_with_options_async('iiiP35sJadba8aBSgjrwPRKgiEiF', 'M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv', get_subscribed_calendar_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\GetSubscribedCalendarHeaders;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号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();
        $getSubscribedCalendarHeaders = new GetSubscribedCalendarHeaders([]);
        $getSubscribedCalendarHeaders->xAcsDingtalkAccessToken = "<your access token>";
        try {
            $client->getSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", $getSubscribedCalendarHeaders, 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"
)

/**
 * 使用 Token 初始化账号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
  }

  getSubscribedCalendarHeaders := &dingtalkcalendar_1_0.GetSubscribedCalendarHeaders{}
  getSubscribedCalendarHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetSubscribedCalendarWithOptions(tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"), tea.String("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv"), getSubscribedCalendarHeaders, &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 {

  /**
   * 使用 Token 初始化账号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 getSubscribedCalendarHeaders = new $dingtalkcalendar_1_0.GetSubscribedCalendarHeaders({ });
    getSubscribedCalendarHeaders.xAcsDingtalkAccessToken = "<your access token>";
    try {
      await client.getSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", getSubscribedCalendarHeaders, 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 
    {

        /**
         * 使用 Token 初始化账号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.GetSubscribedCalendarHeaders getSubscribedCalendarHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetSubscribedCalendarHeaders();
            getSubscribedCalendarHeaders.XAcsDingtalkAccessToken = "<your access token>";
            try
            {
                client.GetSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", getSubscribedCalendarHeaders, 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 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
calendarId	String	订阅日历id。
name	String	日历标题。
description	String	日历描述。
author	String	日历创建者。
managers	Array of String	可编辑人员的unionId。
subscribeScope	Object	可订阅范围。
unionIds	Array of String	可订阅人员的unionId列表。
openConversationIds	Array of String	可订阅群组的OpenConversationId列表。
corpIds	Array of String	可订阅组织的corpId列表。

响应体示例

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

{
  "calendarId" : "M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv",
  "name" : "中国传统日历",
  "description" : "中国传统日历",
  "author" : "iiiP35sJadba8aBSgjrwPRKgiEiF",
  "managers" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ],
  "subscribeScope" : {
    "unionIds" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ],
    "openConversationIds" : [ "cidvrURjEqVe8xxxxxxx" ],
    "corpIds" : [ "dingz0xc7v89789asasdf" ]
  }
}

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	invalidParameter	forwardErrorMessage	参数异常
400	invalidParameter	calendar id cannot be null	日历id不能为空
403	permissionDenied	permission denied	鉴权失败

​请求

​基本信息

​请求头

​路径参数

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

路径参数

请求示例

响应

响应体

响应体示例

错误码