> ## Documentation Index > Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt > Use this file to discover all available pages before exploring further. # ファイル変更イベントをサブスクライブする > 企業またはスペース単位でファイル変更イベントをサブスクライブし、イベント通知を受け取ります 本 API を呼び出して、ファイル変更イベントをサブスクライブします。 ## API 呼び出し説明 1. 開発者管理画面のアプリイベントサブスクリプションで、まずストレージイベントのサブスクリプションをオンにします。 2. 本 API を呼び出し、サブスクライブ範囲として企業または指定のストレージスペースを指定します。 ### 説明 開発者管理画面でストレージイベントサブスクリプションのスイッチをオンにするだけでは、コールバックイベントを受信できません。必ず本 API と組み合わせて使用してください。 ## リクエスト ### ベーシック情報 | フィールド | 値 | | ------------- | -------------------------------------------------------------------------------------------------------------- | | HTTP URL | [https://api.dingtalk.io/v1.0/storage/events/subscribe](https://api.dingtalk.io/v1.0/storage/events/subscribe) | | HTTP Method | POST | | サポートされるアプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ | | 権限要件 | permission-Storage.Event.Write-企業ストレージファイル変更イベントサブスクリプション書き込み権限 | ### リクエストヘッダー | 名前 | タイプ | 必須 | 説明 | | --------------------------- | ------ | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | はい | この API を呼び出すためのアクセス認証情報。以下の方法で取得します: - 社内アプリの場合は、[社内アプリの accessToken を取得する](/ja/open/development/obtain-the-access-token-of-an-internal-app#) API を呼び出して取得します。 - サードパーティ社内アプリの場合は、[サードパーティアプリの権限付与企業の accessToken を取得する](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API を呼び出して取得します。 | ### クエリパラメータ | 名前 | タイプ | 必須 | 説明 | | ------- | ------ | -- | -------------------------------------------------------------------------------------- | | unionId | String | はい | 操作者の unionId。[ユーザー詳細を照会する](/ja/open/development/query-user-details#) API を呼び出して取得できます。 | ### リクエストボディ | 名前 | タイプ | 必須 | 説明 | | ------- | ------ | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | scopeId | String | はい | サブスクライブ範囲に対応する ID。 - scope パラメータの値が ORG の場合、scopeId は企業の corpId に対応します。[ベーシックコンセプト-CorpId](/ja/open/dingstart/basic-concepts-beta#section-bbk-mv0-oxd) を参照してください。 - scope が SPACE の場合、scopeId はストレージスペースの ID に対応します。[スペースを追加する](/ja/open/development/add-space#) API を呼び出して id を取得できます。 | | scope | String | はい | サブスクライブ範囲。 - ORG: 企業 - SPACE: スペース | ### リクエスト例 HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v1.0/storage/events/subscribe?unionId=union_id HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:xxxxx Content-Type:application/json { "scopeId" : "SPACE", "scope" : "SPACE" } ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package com.aliyun.sample; import com.aliyun.tea.*; public class Sample { /** * Token を使用してアカウント Client を初期化します * @return Client * @throws Exception */ public static com.aliyun.dingtalkstorage_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.dingtalkstorage_1_0.Client(config); } public static void main(String[] args_) throws Exception { java.util.List args = java.util.Arrays.asList(args_); com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient(); com.aliyun.dingtalkstorage_1_0.models.SubscribeEventHeaders subscribeEventHeaders = new com.aliyun.dingtalkstorage_1_0.models.SubscribeEventHeaders(); subscribeEventHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkstorage_1_0.models.SubscribeEventRequest subscribeEventRequest = new com.aliyun.dingtalkstorage_1_0.models.SubscribeEventRequest() .setUnionId("union_id") .setScopeId("SPACE") .setScope("SPACE"); try { client.subscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, 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 ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- coding: utf-8 -*- # This file is auto-generated, don't edit it. Thanks. import sys from typing import List from alibabacloud_dingtalk.storage_1_0.client import Client as dingtalkstorage_1_0Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__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() -> dingtalkstorage_1_0Client: """ Token を使用してアカウント Client を初期化します @return: Client @throws Exception """ config = open_api_models.Config() config.protocol = 'https' config.region_id = 'central' return dingtalkstorage_1_0Client(config) @staticmethod def main( args: List[str], ) -> None: client = Sample.create_client() subscribe_event_headers = dingtalkstorage__1__0_models.SubscribeEventHeaders() subscribe_event_headers.x_acs_dingtalk_access_token = '' subscribe_event_request = dingtalkstorage__1__0_models.SubscribeEventRequest( union_id='union_id', scope_id='SPACE', scope='SPACE' ) try: client.subscribe_event_with_options(subscribe_event_request, subscribe_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() subscribe_event_headers = dingtalkstorage__1__0_models.SubscribeEventHeaders() subscribe_event_headers.x_acs_dingtalk_access_token = '' subscribe_event_request = dingtalkstorage__1__0_models.SubscribeEventRequest( union_id='union_id', scope_id='SPACE', scope='SPACE' ) try: await client.subscribe_event_with_options_async(subscribe_event_request, subscribe_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 ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $subscribeEventHeaders = new SubscribeEventHeaders([]); $subscribeEventHeaders->xAcsDingtalkAccessToken = ""; $subscribeEventRequest = new SubscribeEventRequest([ "unionId" => "union_id", "scopeId" => "SPACE", "scope" => "SPACE" ]); try { $client->subscribeEventWithOptions($subscribeEventRequest, $subscribeEventHeaders, 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)); ``` Go ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package main import ( "os" util "github.com/alibabacloud-go/tea-utils/v2/service" dingtalkstorage_1_0 "github.com/alibabacloud-go/dingtalk/storage_1_0" openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client" "github.com/alibabacloud-go/tea/tea" ) /** * Token を使用してアカウント Client を初期化します * @return Client * @throws Exception */ func CreateClient () (_result *dingtalkstorage_1_0.Client, _err error) { config := &openapi.Config{} config.Protocol = tea.String("https") config.RegionId = tea.String("central") _result = &dingtalkstorage_1_0.Client{} _result, _err = dingtalkstorage_1_0.NewClient(config) return _result, _err } func _main (args []*string) (_err error) { client, _err := CreateClient() if _err != nil { return _err } subscribeEventHeaders := &dingtalkstorage_1_0.SubscribeEventHeaders{} subscribeEventHeaders.XAcsDingtalkAccessToken = tea.String("") subscribeEventRequest := &dingtalkstorage_1_0.SubscribeEventRequest{ UnionId: tea.String("union_id"), ScopeId: tea.String("SPACE"), Scope: tea.String("SPACE"), } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.SubscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, &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 ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it import Util, * as $Util from '@alicloud/tea-util'; import dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_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(): dingtalkstorage_1_0 { let config = new $OpenApi.Config({ }); config.protocol = "https"; config.regionId = "central"; return new dingtalkstorage_1_0(config); } static async main(args: string[]): Promise { let client = Client.createClient(); let subscribeEventHeaders = new $dingtalkstorage_1_0.SubscribeEventHeaders({ }); subscribeEventHeaders.xAcsDingtalkAccessToken = ""; let subscribeEventRequest = new $dingtalkstorage_1_0.SubscribeEventRequest({ unionId: "union_id", scopeId: "SPACE", scope: "SPACE", }); try { await client.subscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err には code と message 属性が含まれ、問題の特定に役立ちます } } } } Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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.Dingtalkstorage_1_0.Client CreateClient() { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config(); config.Protocol = "https"; config.RegionId = "central"; return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config); } public static void Main(string[] args) { AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient(); AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventHeaders subscribeEventHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventHeaders(); subscribeEventHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventRequest subscribeEventRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventRequest { UnionId = "union_id", ScopeId = "SPACE", Scope = "SPACE", }; try { client.SubscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, 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 { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err には code と message 属性が含まれ、問題の特定に役立ちます } } } } } ``` ## レスポンス ### レスポンスボディ | 名前 | タイプ | 説明 | | ------- | ------- | ----------------------------- | | success | Boolean | 今回の操作が成功したかどうか。true は成功を示します。 | ### レスポンスボディ例 ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "success" : true } ``` ### エラーコード この API の呼び出し時にエラーが発生した場合は、エラーメッセージをもとに [グローバルエラーコード](/ja/open/development/server-api-error-codes-1) ドキュメントで解決方法を検索してください。 | HttpCode | エラーコード | エラーメッセージ | 説明 | | -------- | ------------------ | ------------- | --------------------------- | | 400 | paramError | %s | パラメータエラー | | 400 | paramError.scope | %s | パラメータエラー-scope | | 400 | paramError.scopeId | %s | パラメータエラー-scopeId | | 403 | permissionDenied | %s | ユーザーにイベントをサブスクライブする権限がありません | | 500 | systemError | %s | システムエラー | | 500 | unknownError | Unknown Error | 不明なエラー | | 503 | operationTimeout | %s | リクエストタイムアウト |