Create a subscription calendar - DingTalk Help Center

Call this API to create a subscription calendar.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/calendar/users/{userId}/subscribedCalendars`
HTTP Method	POST
Supported app types	appType-Internal app　appType-Third-party enterprise app　appType-Third-party personal app
Required permissions	permission-Calendar.Calendar.Write-Write permission for the Calendar app

Request header

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an enterprise that authorized a third-party app API. - For a third-party personal app, call the Get the user token API.

Path parameters

Name	Type	Required	Description
userId	String	Yes	The unionId of the calendar creator. - For an internal app or a third-party enterprise app, call the Query user details API to obtain the value of the unionid parameter. - For a third-party personal app, call the Get the user’s contact profile API to obtain the value of the unionId parameter.

Request body

Name	Type	Required	Description
name	String	Yes	The name of the subscription calendar.
description	String	No	The description of the subscription calendar. Maximum length: 1,024 characters.
managers	Array of String	No	The unionId values of the co-editors of the subscription calendar. - For an internal app or a third-party enterprise app, call the Query user details API to obtain the value of the unionid parameter. - For a third-party personal app, call the Get the user’s contact profile API to obtain the value of the unionId parameter.
subscribeScope	Object	Yes	The objects that can subscribe to this calendar.
unionIds	Array of String	No	The unionId values of the users that can subscribe to this calendar. - For an internal app or a third-party enterprise app, call the Query user details API to obtain the value of the unionid parameter. - For a third-party personal app, call the Get the user’s contact profile API to obtain the value of the unionId parameter.
openConversationIds	Array of String	No	The list of OpenConversationIds of the groups that can subscribe to this calendar. - For an internal app, call the Get the OpenConversationId of a group chat API to obtain the value of the openConversationId parameter. - For a third-party enterprise app, call the Create a group API to obtain the value of the open_conversation_id parameter. - The unionId of the event creator must belong to a group specified in openConversationIds or to an organization specified in corpIds. - This parameter is not required for a third-party personal app.
corpIds	Array of String	No	The list of organization corpIds that can subscribe to this calendar. Sign in to the DingTalk Developer Console and view your organization ID on the Home page. The unionId of the event creator must belong to the organization specified by corpId or to a group specified in openConversationIds.

Request example

HTTP

POST /v1.0/calendar/users/iiiP35sJadba8aBSgjrwPRKgiEiF/subscribedCalendars HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT01
Content-Type:application/json

{
  "name" : "Traditional Chinese Festivals",
  "description" : "Traditional Chinese Festivals",
  "managers" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ],
  "subscribeScope" : {
    "unionIds" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ],
    "openConversationIds" : [ "cidvrURjEqVe8xxxxxxx" ],
    "corpIds" : [ "dingz0xc7v89789asasdf" ]
  }
}

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 {

    /**
     * Initialize the account Client using a Token
     * @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();
        CreateSubscribedCalendarHeaders createSubscribedCalendarHeaders = new CreateSubscribedCalendarHeaders();
        createSubscribedCalendarHeaders.xAcsDingtalkAccessToken = "<your access token>";
        CreateSubscribedCalendarRequest.CreateSubscribedCalendarRequestSubscribeScope subscribeScope = new CreateSubscribedCalendarRequest.CreateSubscribedCalendarRequestSubscribeScope()
                .setUnionIds(java.util.Arrays.asList(
                    "iiiP35sJadba8aBSgjrwPRKgiEiF"
                ))
                .setOpenConversationIds(java.util.Arrays.asList(
                    "cidvrURjEqVe8xxxxxxx"
                ))
                .setCorpIds(java.util.Arrays.asList(
                    "dingz0xc7v89789asasdf"
                ));
        CreateSubscribedCalendarRequest createSubscribedCalendarRequest = new CreateSubscribedCalendarRequest()
                .setName("Traditional Chinese Festivals")
                .setDescription("Traditional Chinese Festivals")
                .setManagers(java.util.Arrays.asList(
                    "iiiP35sJadba8aBSgjrwPRKgiEiF"
                ))
                .setSubscribeScope(subscribeScope);
        try {
            client.createSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", createSubscribedCalendarRequest, createSubscribedCalendarHeaders, new 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 that help with troubleshooting
            }

        } 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 that help with troubleshooting
            }

        }        
    }
}

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:
        """
        Initialize the account Client using 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()
        create_subscribed_calendar_headers = dingtalkcalendar__1__0_models.CreateSubscribedCalendarHeaders()
        create_subscribed_calendar_headers.x_acs_dingtalk_access_token = '<your access token>'
        subscribe_scope = dingtalkcalendar__1__0_models.CreateSubscribedCalendarRequestSubscribeScope(
            union_ids=[
                'iiiP35sJadba8aBSgjrwPRKgiEiF'
            ],
            open_conversation_ids=[
                'cidvrURjEqVe8xxxxxxx'
            ],
            corp_ids=[
                'dingz0xc7v89789asasdf'
            ]
        )
        create_subscribed_calendar_request = dingtalkcalendar__1__0_models.CreateSubscribedCalendarRequest(
            name='Traditional Chinese Festivals',
            description='Traditional Chinese Festivals',
            managers=[
                'iiiP35sJadba8aBSgjrwPRKgiEiF'
            ],
            subscribe_scope=subscribe_scope
        )
        try:
            client.create_subscribed_calendar_with_options('iiiP35sJadba8aBSgjrwPRKgiEiF', create_subscribed_calendar_request, create_subscribed_calendar_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 that help with troubleshooting
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_subscribed_calendar_headers = dingtalkcalendar__1__0_models.CreateSubscribedCalendarHeaders()
        create_subscribed_calendar_headers.x_acs_dingtalk_access_token = '<your access token>'
        subscribe_scope = dingtalkcalendar__1__0_models.CreateSubscribedCalendarRequestSubscribeScope(
            union_ids=[
                'iiiP35sJadba8aBSgjrwPRKgiEiF'
            ],
            open_conversation_ids=[
                'cidvrURjEqVe8xxxxxxx'
            ],
            corp_ids=[
                'dingz0xc7v89789asasdf'
            ]
        )
        create_subscribed_calendar_request = dingtalkcalendar__1__0_models.CreateSubscribedCalendarRequest(
            name='Traditional Chinese Festivals',
            description='Traditional Chinese Festivals',
            managers=[
                'iiiP35sJadba8aBSgjrwPRKgiEiF'
            ],
            subscribe_scope=subscribe_scope
        )
        try:
            await client.create_subscribed_calendar_with_options_async('iiiP35sJadba8aBSgjrwPRKgiEiF', create_subscribed_calendar_request, create_subscribed_calendar_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 that help with troubleshooting
                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\CreateSubscribedCalendarHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\CreateSubscribedCalendarRequest\subscribeScope;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\CreateSubscribedCalendarRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a Token
     * @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();
        $createSubscribedCalendarHeaders = new CreateSubscribedCalendarHeaders([]);
        $createSubscribedCalendarHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $subscribeScope = new subscribeScope([
            "unionIds" => [
                "iiiP35sJadba8aBSgjrwPRKgiEiF"
            ],
            "openConversationIds" => [
                "cidvrURjEqVe8xxxxxxx"
            ],
            "corpIds" => [
                "dingz0xc7v89789asasdf"
            ]
        ]);
        $createSubscribedCalendarRequest = new CreateSubscribedCalendarRequest([
            "name" => "Traditional Chinese Festivals",
            "description" => "Traditional Chinese Festivals",
            "managers" => [
                "iiiP35sJadba8aBSgjrwPRKgiEiF"
            ],
            "subscribeScope" => $subscribeScope
        ]);
        try {
            $client->createSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", $createSubscribedCalendarRequest, $createSubscribedCalendarHeaders, 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 that help with troubleshooting
            }
        }
    }
}
$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"
)

/**
 * Initialize the account Client using 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
  }

  createSubscribedCalendarHeaders := &dingtalkcalendar_1_0.CreateSubscribedCalendarHeaders{}
  createSubscribedCalendarHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  subscribeScope := &dingtalkcalendar_1_0.CreateSubscribedCalendarRequestSubscribeScope{
    UnionIds: []*string{tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF")},
    OpenConversationIds: []*string{tea.String("cidvrURjEqVe8xxxxxxx")},
    CorpIds: []*string{tea.String("dingz0xc7v89789asasdf")},
  }
  createSubscribedCalendarRequest := &dingtalkcalendar_1_0.CreateSubscribedCalendarRequest{
    Name: tea.String("Traditional Chinese Festivals"),
    Description: tea.String("Traditional Chinese Festivals"),
    Managers: []*string{tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF")},
    SubscribeScope: subscribeScope,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateSubscribedCalendarWithOptions(tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"), createSubscribedCalendarRequest, createSubscribedCalendarHeaders, &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 that help with troubleshooting
    }

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

  /**
   * Initialize the account Client using 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<void> {
    let client = Client.createClient();
    let createSubscribedCalendarHeaders = new $dingtalkcalendar_1_0.CreateSubscribedCalendarHeaders({ });
    createSubscribedCalendarHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let subscribeScope = new $dingtalkcalendar_1_0.CreateSubscribedCalendarRequestSubscribeScope({
      unionIds: [
        "iiiP35sJadba8aBSgjrwPRKgiEiF"
      ],
      openConversationIds: [
        "cidvrURjEqVe8xxxxxxx"
      ],
      corpIds: [
        "dingz0xc7v89789asasdf"
      ],
    });
    let createSubscribedCalendarRequest = new $dingtalkcalendar_1_0.CreateSubscribedCalendarRequest({
      name: "Traditional Chinese Festivals",
      description: "Traditional Chinese Festivals",
      managers: [
        "iiiP35sJadba8aBSgjrwPRKgiEiF"
      ],
      subscribeScope: subscribeScope,
    });
    try {
      await client.createSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", createSubscribedCalendarRequest, createSubscribedCalendarHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that help with troubleshooting
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client using 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.CreateSubscribedCalendarHeaders createSubscribedCalendarHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.CreateSubscribedCalendarHeaders();
            createSubscribedCalendarHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.CreateSubscribedCalendarRequest.CreateSubscribedCalendarRequestSubscribeScope subscribeScope = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.CreateSubscribedCalendarRequest.CreateSubscribedCalendarRequestSubscribeScope
            {
                UnionIds = new List<string>
                {
                    "iiiP35sJadba8aBSgjrwPRKgiEiF"
                },
                OpenConversationIds = new List<string>
                {
                    "cidvrURjEqVe8xxxxxxx"
                },
                CorpIds = new List<string>
                {
                    "dingz0xc7v89789asasdf"
                },
            };
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.CreateSubscribedCalendarRequest createSubscribedCalendarRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.CreateSubscribedCalendarRequest
            {
                Name = "Traditional Chinese Festivals",
                Description = "Traditional Chinese Festivals",
                Managers = new List<string>
                {
                    "iiiP35sJadba8aBSgjrwPRKgiEiF"
                },
                SubscribeScope = subscribeScope,
            };
            try
            {
                client.CreateSubscribedCalendarWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", createSubscribedCalendarRequest, createSubscribedCalendarHeaders, 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 that help with troubleshooting
                }
            }
            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 contains code and message attributes that help with troubleshooting
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
calendarId	String	The ID of the subscription calendar.

Response body example

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

{
  "calendarId" : "M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmxxxxxxx"
}

Error codes

If the API call returns an error, refer to the Global error codes document to find a solution based on the error message.

HttpCode	Error code	Error message	Description
400	invalidParameter	forwardErrorMessage	Invalid parameter
400	invalidParameter	calendar name cannot be blank	The calendar name cannot be empty
400	invalidParameter	calendar name length must less than 128	The calendar name cannot exceed 128 characters
400	invalidParameter	subscribe range cannot be null	The subscription range cannot be empty
400	invalidParameter	current user must in range	The current user must be in the corresponding group and organization
403	permissionDenied	permission denied	Authentication failed

​Request

​Basic information

​Request header

​Path parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes

Request

Basic information

Request header

Path parameters

Request body

Request example

Response

Response body

Response body example

Error codes