予定を削除

本 API を呼び出して、指定した予定を削除します。

API 呼び出し説明

主催者が予定を削除する場合（URL に主催者の unionId を使用）、すべての参加者に予定キャンセル通知が送信され、予定はすべての参加者のカレンダーから削除されます。
参加者が予定を削除する場合（URL に参加者の unionId を使用）、その予定は自分のカレンダーからのみ削除され、他の予定参加者には影響しません。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/calendar/users/{userId}/calendars/{calendarId}/events/{eventId}`
HTTP Method	DELETE
対応アプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ　appType-サードパーティ個人アプリ
必要な権限	permission-Calendar.Event.Write-カレンダーアプリにおける予定の書き込み権限

リクエストヘッダー

名前	タイプ	必須	説明
x-client-token	String	任意	冪等性チェック。 - 同じ `x-client-token` は同一リクエストを示します。 - 有効期限は 1 日です。
x-acs-dingtalk-access-token	String	必須	本 API を呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合は社内アプリの accessToken を取得 API を呼び出して取得します。 - サードパーティ社内アプリの場合はサードパーティアプリに認可された企業の accessToken を取得 API を呼び出して取得します。 - サードパーティ個人アプリの場合はユーザートークンを取得 API を呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
userId	String	必須	削除対象の予定が属するユーザーの unionId。 - 社内アプリおよびサードパーティ社内アプリの場合はユーザー詳細を照会 API を呼び出して unionid パラメータの値を取得します。 - サードパーティ個人アプリの場合はユーザーの連絡先プロフィールを取得 API を呼び出して unionId パラメータの値を取得します。
calendarId	String	必須	予定が属するカレンダー ID。primary 固定で、ユーザーのメインカレンダーを示します。
eventId	String	必須	予定 ID。予定を作成 API または予定リストを照会 API を呼び出して id パラメータの値を取得できます。

クエリパラメータ

名前	タイプ	必須	説明
pushNotification	Boolean	任意	ポップアップ通知を行うかどうか: - true: 行う - false: 行わない

リクエスト例

HTTP

DELETE /v1.0/calendar/users/iiiP35sJadba8aBSgjrwPRKgiEiF/calendars/primary/events/cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09?pushNotification=true HTTP/1.1
Host:api.dingtalk.io
x-client-token:******
x-acs-dingtalk-access-token:dd43888e26953deead8cba556389b064
Content-Type:application/json

Java

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウント Client を初期化
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkcalendar_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.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();
        com.aliyun.dingtalkcalendar_1_0.models.DeleteEventHeaders deleteEventHeaders = new com.aliyun.dingtalkcalendar_1_0.models.DeleteEventHeaders();
        deleteEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcalendar_1_0.models.DeleteEventRequest deleteEventRequest = new com.aliyun.dingtalkcalendar_1_0.models.DeleteEventRequest()
                .setPushNotification(true);
        try {
            client.deleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", deleteEventRequest, deleteEventHeaders, new com.aliyun.teautil.models.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 os
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()
        delete_event_headers = dingtalkcalendar__1__0_models.DeleteEventHeaders()
        delete_event_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_event_request = dingtalkcalendar__1__0_models.DeleteEventRequest(
            push_notification=True
        )
        try:
            client.delete_event_with_options('iiiP35sJadba8aBSgjrwPRKgiEiF', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09', delete_event_request, delete_event_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()
        delete_event_headers = dingtalkcalendar__1__0_models.DeleteEventHeaders()
        delete_event_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_event_request = dingtalkcalendar__1__0_models.DeleteEventRequest(
            push_notification=True
        )
        try:
            await client.delete_event_with_options_async('iiiP35sJadba8aBSgjrwPRKgiEiF', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09', delete_event_request, delete_event_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\DeleteEventHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\DeleteEventRequest;
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();
        $deleteEventHeaders = new DeleteEventHeaders([]);
        $deleteEventHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteEventRequest = new DeleteEventRequest([
            "pushNotification" => true
        ]);
        try {
            $client->deleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", $deleteEventRequest, $deleteEventHeaders, 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/v2/service"
  dingtalkcalendar_1_0  "github.com/alibabacloud-go/dingtalk/calendar_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/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
  }

  deleteEventHeaders := &dingtalkcalendar_1_0.DeleteEventHeaders{}
  deleteEventHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  deleteEventRequest := &dingtalkcalendar_1_0.DeleteEventRequest{
    PushNotification: tea.Bool(true),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteEventWithOptions(tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"), tea.String("primary"), tea.String("cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09"), deleteEventRequest, deleteEventHeaders, &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 deleteEventHeaders = new $dingtalkcalendar_1_0.DeleteEventHeaders({ });
    deleteEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let deleteEventRequest = new $dingtalkcalendar_1_0.DeleteEventRequest({
      pushNotification: true,
    });
    try {
      await client.deleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", deleteEventRequest, deleteEventHeaders, 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.DeleteEventHeaders deleteEventHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.DeleteEventHeaders();
            deleteEventHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.DeleteEventRequest deleteEventRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.DeleteEventRequest
            {
                PushNotification = true,
            };
            try
            {
                client.DeleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", deleteEventRequest, deleteEventHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ例

HTTP/1.1 200 OK

エラーコード

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

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidParameter	forwardErrorMessage	パラメータエラー
400	idempotencyProcessing	Idempotency processing	冪等リクエスト処理中
404	itemNotFound	forwardErrorMessage	指定された予定が見つかりません

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ例

エラーコード