Skip to main content
Call this operation to delete recycle items in the Recycle Bin in batches. Deleted files cannot be restored.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/recycleBins/{recycleBinId}/recycleItems/batchRemove
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Permissionspermission-Storage.RecycleBin.Write-Write permission on the organization storage Recycle Bin

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this operation. Obtain it as follows: - For an internal app, call the Obtain the access token of an internal app operation. - For a third-party enterprise app, call the Obtain the access token of an authorized enterprise of a third-party app operation.

Path parameter

NameTypeRequiredDescription
recycleBinIdStringYesThe Recycle Bin ID. To obtain it, call the Obtain Recycle Bin information operation.

Query parameter

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. To obtain it, call the Query user details operation.

Request body

NameTypeRequiredDescription
recycleItemIdsArray of StringYesThe list of recycle item IDs. The maximum length is 50. To obtain the id parameter value, call the Obtain the list of recycle items operation.

Request example

HTTP
POST /v1.0/storage/recycleBins/pQy3R7xxxxx/recycleItems/batchRemove?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "recycleItemIds" : [ "2190xxxxx" ]
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with a Token
     * @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<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.DeleteRecycleItemsHeaders deleteRecycleItemsHeaders = new com.aliyun.dingtalkstorage_1_0.models.DeleteRecycleItemsHeaders();
        deleteRecycleItemsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.DeleteRecycleItemsRequest deleteRecycleItemsRequest = new com.aliyun.dingtalkstorage_1_0.models.DeleteRecycleItemsRequest()
                .setUnionId("chyxxxxx")
                .setRecycleItemIds(java.util.Arrays.asList(
                    "2190xxxxx"
                ));
        try {
            client.deleteRecycleItemsWithOptions("pQy3R7xxxxx", deleteRecycleItemsRequest, deleteRecycleItemsHeaders, 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 contains code and message attributes that help locate the issue
            }

        } 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 locate the issue
            }

        }        
    }
}
Python
# -*- 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:
        """
        Initialize the account Client with a Token
        @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()
        delete_recycle_items_headers = dingtalkstorage__1__0_models.DeleteRecycleItemsHeaders()
        delete_recycle_items_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_recycle_items_request = dingtalkstorage__1__0_models.DeleteRecycleItemsRequest(
            union_id='chyxxxxx',
            recycle_item_ids=[
                '2190xxxxx'
            ]
        )
        try:
            client.delete_recycle_items_with_options('pQy3R7xxxxx', delete_recycle_items_request, delete_recycle_items_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 locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        delete_recycle_items_headers = dingtalkstorage__1__0_models.DeleteRecycleItemsHeaders()
        delete_recycle_items_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_recycle_items_request = dingtalkstorage__1__0_models.DeleteRecycleItemsRequest(
            union_id='chyxxxxx',
            recycle_item_ids=[
                '2190xxxxx'
            ]
        )
        try:
            await client.delete_recycle_items_with_options_async('pQy3R7xxxxx', delete_recycle_items_request, delete_recycle_items_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 locate the issue
                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\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\DeleteRecycleItemsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\DeleteRecycleItemsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $deleteRecycleItemsHeaders = new DeleteRecycleItemsHeaders([]);
        $deleteRecycleItemsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteRecycleItemsRequest = new DeleteRecycleItemsRequest([
            "unionId" => "chyxxxxx",
            "recycleItemIds" => [
                "2190xxxxx"
            ]
        ]);
        try {
            $client->deleteRecycleItemsWithOptions("pQy3R7xxxxx", $deleteRecycleItemsRequest, $deleteRecycleItemsHeaders, 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 locate the issue
            }
        }
    }
}
$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
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/service"
  dingtalkstorage_1_0  "github.com/alibabacloud-go/dingtalk/storage_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account Client with a Token
 * @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
  }

  deleteRecycleItemsHeaders := &dingtalkstorage_1_0.DeleteRecycleItemsHeaders{}
  deleteRecycleItemsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  deleteRecycleItemsRequest := &dingtalkstorage_1_0.DeleteRecycleItemsRequest{
    UnionId: tea.String("chyxxxxx"),
    RecycleItemIds: []*string{tea.String("2190xxxxx")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteRecycleItemsWithOptions(tea.String("pQy3R7xxxxx"), deleteRecycleItemsRequest, deleteRecycleItemsHeaders, &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 locate the issue
    }

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

  /**
   * Initialize the account Client with a Token
   * @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<void> {
    let client = Client.createClient();
    let deleteRecycleItemsHeaders = new $dingtalkstorage_1_0.DeleteRecycleItemsHeaders({ });
    deleteRecycleItemsHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let deleteRecycleItemsRequest = new $dingtalkstorage_1_0.DeleteRecycleItemsRequest({
      unionId: "chyxxxxx",
      recycleItemIds: [
        "2190xxxxx"
      ],
    });
    try {
      await client.deleteRecycleItemsWithOptions("pQy3R7xxxxx", deleteRecycleItemsRequest, deleteRecycleItemsHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// 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 with a Token
         * @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.DeleteRecycleItemsHeaders deleteRecycleItemsHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteRecycleItemsHeaders();
            deleteRecycleItemsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteRecycleItemsRequest deleteRecycleItemsRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteRecycleItemsRequest
            {
                UnionId = "chyxxxxx",
                RecycleItemIds = new List<string>
                {
                    "2190xxxxx"
                },
            };
            try
            {
                client.DeleteRecycleItemsWithOptions("pQy3R7xxxxx", deleteRecycleItemsRequest, deleteRecycleItemsHeaders, 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 locate the issue
                }
            }
            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 locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
successBooleanWhether the operation succeeded. - true: Success - false: Failed

Response body example

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

{
  "success" : true
}

Error codes

If an error occurs when you call this operation, see the Global error codes document for a solution based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error
400paramError.recycleBinId%sParameter error - recycleBinId
400paramError.recycleItemIds%sParameter error - recycleItemIds
403permissionDenied%sThe user lacks management permissions on the original file or folder of the recycle item.
404recycleBinNotExist%sThe Recycle Bin does not exist.
404recycleItemNotExist%sThe recycle item does not exist.
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error
503operationTimeout%sRequest timed out