リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/calendar/users/{userId}/subscribedCalendars/{calendarId} |
| HTTP Method | PUT |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ appType-サードパーティ個人アプリ |
| 必要な権限 | permission-Calendar.Calendar.Write-カレンダーアプリの書き込み権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | 本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、社内アプリのアクセストークンを取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリ認可企業のアクセストークンを取得インターフェースを呼び出して取得します。 - サードパーティ個人アプリの場合、ユーザートークンを取得インターフェースを呼び出して取得します。 |
パスパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| calendarId | String | はい | 購読カレンダー ID。購読カレンダーの作成インターフェースを呼び出して calendarId パラメータの値を取得できます。 |
| userId | String | はい | カレンダー作成者または共同編集者の unionId。 - 社内アプリおよびサードパーティ社内アプリの場合、ユーザー詳細の照会インターフェースを呼び出して unionid パラメータの値を取得します。 - サードパーティ個人アプリの場合、ユーザー連絡先のプロフィール情報を取得インターフェースを呼び出して unionId パラメータの値を取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | String | いいえ | 購読カレンダーの見出し。 |
| description | String | いいえ | 購読カレンダーの説明。 |
| managers | Array of String | いいえ | カレンダー共同編集者の unionId リスト。 - 社内アプリおよびサードパーティ社内アプリの場合、ユーザー詳細の照会インターフェースを呼び出して unionid パラメータの値を取得します。 - サードパーティ個人アプリの場合、ユーザー連絡先のプロフィール情報を取得インターフェースを呼び出して unionId パラメータの値を取得します。 |
| subscribeScope | Object | いいえ | カレンダーの購読可能範囲。 |
| unionIds | Array of String | いいえ | 当該カレンダーを購読可能なメンバーの unionId。 - 社内アプリおよびサードパーティ社内アプリの場合、ユーザー詳細の照会インターフェースを呼び出して unionid パラメータの値を取得します。 - サードパーティ個人アプリの場合、ユーザー連絡先のプロフィール情報を取得インターフェースを呼び出して unionId パラメータの値を取得します。 |
| openConversationIds | Array of String | いいえ | 当該カレンダーを購読可能なグループの OpenConversationId リスト。 - 社内アプリの場合、グループチャットの OpenConversationId を取得インターフェースを呼び出して openConversationId パラメータの値を取得します。 - サードパーティ社内アプリの場合、グループの作成インターフェースを呼び出して open_conversation_id パラメータの値を取得します。 - 当該購読予定の作成者が所属するグループの OpenConversationId を渡す必要があります。 - サードパーティ個人アプリではこのパラメータを渡す必要はありません。 |
| corpIds | Array of String | いいえ | 当該カレンダーを購読可能な組織 corpId リスト。DingTalk 開発者バックエンドにログインし、ホーム画面で企業の組織 ID を確認します。 当該購読予定の作成者が所属する組織の組織 ID を渡す必要があります。 |
リクエスト例
HTTPPUT /v1.0/calendar/users/iiiP35sJadba8aBSgjrwPRKgiEiF/subscribedCalendars/M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT01
Content-Type:application/json
{
"name" : "中国伝統カレンダー",
"description" : "中国伝統カレンダー",
"managers" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ],
"subscribeScope" : {
"unionIds" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ],
"openConversationIds" : [ "cidvrURjEqVe8xxxxxxx" ],
"corpIds" : [ "dingz0xc7v89789asasdf" ]
}
}
// 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();
UpdateSubscribedCalendarsHeaders updateSubscribedCalendarsHeaders = new UpdateSubscribedCalendarsHeaders();
updateSubscribedCalendarsHeaders.xAcsDingtalkAccessToken = "<your access token>";
UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope subscribeScope = new UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope()
.setUnionIds(java.util.Arrays.asList(
"iiiP35sJadba8aBSgjrwPRKgiEiF"
))
.setOpenConversationIds(java.util.Arrays.asList(
"cidvrURjEqVe8xxxxxxx"
))
.setCorpIds(java.util.Arrays.asList(
"dingz0xc7v89789asasdf"
));
UpdateSubscribedCalendarsRequest updateSubscribedCalendarsRequest = new UpdateSubscribedCalendarsRequest()
.setName("中国伝統カレンダー")
.setDescription("中国伝統カレンダー")
.setManagers(java.util.Arrays.asList(
"iiiP35sJadba8aBSgjrwPRKgiEiF"
))
.setSubscribeScope(subscribeScope);
try {
client.updateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, 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 属性が含まれ、開発時の問題特定に役立ちます
}
}
}
}
# -*- 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()
update_subscribed_calendars_headers = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsHeaders()
update_subscribed_calendars_headers.x_acs_dingtalk_access_token = '<your access token>'
subscribe_scope = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequestSubscribeScope(
union_ids=[
'iiiP35sJadba8aBSgjrwPRKgiEiF'
],
open_conversation_ids=[
'cidvrURjEqVe8xxxxxxx'
],
corp_ids=[
'dingz0xc7v89789asasdf'
]
)
update_subscribed_calendars_request = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequest(
name='中国伝統カレンダー',
description='中国伝統カレンダー',
managers=[
'iiiP35sJadba8aBSgjrwPRKgiEiF'
],
subscribe_scope=subscribe_scope
)
try:
client.update_subscribed_calendars_with_options('M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv', 'iiiP35sJadba8aBSgjrwPRKgiEiF', update_subscribed_calendars_request, update_subscribed_calendars_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()
update_subscribed_calendars_headers = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsHeaders()
update_subscribed_calendars_headers.x_acs_dingtalk_access_token = '<your access token>'
subscribe_scope = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequestSubscribeScope(
union_ids=[
'iiiP35sJadba8aBSgjrwPRKgiEiF'
],
open_conversation_ids=[
'cidvrURjEqVe8xxxxxxx'
],
corp_ids=[
'dingz0xc7v89789asasdf'
]
)
update_subscribed_calendars_request = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequest(
name='中国伝統カレンダー',
description='中国伝統カレンダー',
managers=[
'iiiP35sJadba8aBSgjrwPRKgiEiF'
],
subscribe_scope=subscribe_scope
)
try:
await client.update_subscribed_calendars_with_options_async('M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv', 'iiiP35sJadba8aBSgjrwPRKgiEiF', update_subscribed_calendars_request, update_subscribed_calendars_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
// 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\UpdateSubscribedCalendarsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\UpdateSubscribedCalendarsRequest\subscribeScope;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\UpdateSubscribedCalendarsRequest;
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();
$updateSubscribedCalendarsHeaders = new UpdateSubscribedCalendarsHeaders([]);
$updateSubscribedCalendarsHeaders->xAcsDingtalkAccessToken = "<your access token>";
$subscribeScope = new subscribeScope([
"unionIds" => [
"iiiP35sJadba8aBSgjrwPRKgiEiF"
],
"openConversationIds" => [
"cidvrURjEqVe8xxxxxxx"
],
"corpIds" => [
"dingz0xc7v89789asasdf"
]
]);
$updateSubscribedCalendarsRequest = new UpdateSubscribedCalendarsRequest([
"name" => "中国伝統カレンダー",
"description" => "中国伝統カレンダー",
"managers" => [
"iiiP35sJadba8aBSgjrwPRKgiEiF"
],
"subscribeScope" => $subscribeScope
]);
try {
$client->updateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", $updateSubscribedCalendarsRequest, $updateSubscribedCalendarsHeaders, 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
}
updateSubscribedCalendarsHeaders := &dingtalkcalendar_1_0.UpdateSubscribedCalendarsHeaders{}
updateSubscribedCalendarsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
subscribeScope := &dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequestSubscribeScope{
UnionIds: []*string{tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF")},
OpenConversationIds: []*string{tea.String("cidvrURjEqVe8xxxxxxx")},
CorpIds: []*string{tea.String("dingz0xc7v89789asasdf")},
}
updateSubscribedCalendarsRequest := &dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequest{
Name: tea.String("中国伝統カレンダー"),
Description: tea.String("中国伝統カレンダー"),
Managers: []*string{tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF")},
SubscribeScope: subscribeScope,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.UpdateSubscribedCalendarsWithOptions(tea.String("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv"), tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"), updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, &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)
}
}
// 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 updateSubscribedCalendarsHeaders = new $dingtalkcalendar_1_0.UpdateSubscribedCalendarsHeaders({ });
updateSubscribedCalendarsHeaders.xAcsDingtalkAccessToken = "<your access token>";
let subscribeScope = new $dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequestSubscribeScope({
unionIds: [
"iiiP35sJadba8aBSgjrwPRKgiEiF"
],
openConversationIds: [
"cidvrURjEqVe8xxxxxxx"
],
corpIds: [
"dingz0xc7v89789asasdf"
],
});
let updateSubscribedCalendarsRequest = new $dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequest({
name: "中国伝統カレンダー",
description: "中国伝統カレンダー",
managers: [
"iiiP35sJadba8aBSgjrwPRKgiEiF"
],
subscribeScope: subscribeScope,
});
try {
await client.updateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, 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.UpdateSubscribedCalendarsHeaders updateSubscribedCalendarsHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsHeaders();
updateSubscribedCalendarsHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope subscribeScope = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope
{
UnionIds = new List<string>
{
"iiiP35sJadba8aBSgjrwPRKgiEiF"
},
OpenConversationIds = new List<string>
{
"cidvrURjEqVe8xxxxxxx"
},
CorpIds = new List<string>
{
"dingz0xc7v89789asasdf"
},
};
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest updateSubscribedCalendarsRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest
{
Name = "中国伝統カレンダー",
Description = "中国伝統カレンダー",
Managers = new List<string>
{
"iiiP35sJadba8aBSgjrwPRKgiEiF"
},
SubscribeScope = subscribeScope,
};
try
{
client.UpdateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, 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 属性が含まれ、開発時の問題特定に役立ちます
}
}
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| result | Boolean | インターフェースの呼び出しに成功したかどうか。true は成功を示します。 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : true
}
エラーコード
本インターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法をご確認ください。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | invalidParameter | forwardErrorMessage | パラメータエラー |
| 400 | invalidParameter | calendar id cannot be blank | カレンダー ID は空にできません |
| 400 | invalidParameter | calendar name length must less than 128 | カレンダー名の長さは 128 文字以内にしてください |
| 400 | invalidParameter | subscribe range cannot be null | 購読範囲は空にできません |
| 400 | invalidParameter | calendar name cannot be blank | カレンダー名は空にできません |
| 400 | invalidParameter | current user must in range | 現在のユーザーは該当するグループおよび企業内に所属している必要があります |
| 403 | permissionDenied | permission denied | 認証失敗 |