Skip to main content
Call this API to retrieve detailed information about all items in the Recycle Bin with pagination, including the original space ID, original path, size, and name.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/recycleBins/{recycleBinId}/recycleItems
HTTP MethodGET
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Storage.RecycleBin.Read-Read permission for the organization storage Recycle Bin

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this API. Obtain it in one of the following ways: - 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 the authorized enterprise API.

Path parameters

NameTypeRequiredDescription
recycleBinIdStringYesThe Recycle Bin ID. Call the Get Recycle Bin information API to obtain the value of the id parameter.

Query parameters

NameTypeRequiredDescription
nextTokenStringNoThe pagination cursor. - Leave this parameter empty for the first call. - For subsequent calls, set this parameter to the nextToken value returned in the previous call.
maxResultsIntegerNoThe maximum number of entries per page. Default: 50. Maximum: 50.
unionIdStringYesThe unionId of the operator. Call the Query user details API to obtain it.

Request example

HTTP
GET /v1.0/storage/recycleBins/recyclebin_id/recycleItems?nextToken=next_token&maxResults=30&unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
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 {

    /**
     * Initialize the account Client using 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.ListRecycleItemsHeaders listRecycleItemsHeaders = new com.aliyun.dingtalkstorage_1_0.models.ListRecycleItemsHeaders();
        listRecycleItemsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.ListRecycleItemsRequest listRecycleItemsRequest = new com.aliyun.dingtalkstorage_1_0.models.ListRecycleItemsRequest()
                .setNextToken("next_token")
                .setMaxResults(30)
                .setUnionId("chyxxxxx");
        try {
            client.listRecycleItemsWithOptions("recyclebin_id", listRecycleItemsRequest, listRecycleItemsHeaders, 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 the code and message attributes, which 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 the code and message attributes, which 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.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 using 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()
        list_recycle_items_headers = dingtalkstorage__1__0_models.ListRecycleItemsHeaders()
        list_recycle_items_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_recycle_items_request = dingtalkstorage__1__0_models.ListRecycleItemsRequest(
            next_token='next_token',
            max_results=30,
            union_id='chyxxxxx'
        )
        try:
            client.list_recycle_items_with_options('recyclebin_id', list_recycle_items_request, list_recycle_items_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help with troubleshooting
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_recycle_items_headers = dingtalkstorage__1__0_models.ListRecycleItemsHeaders()
        list_recycle_items_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_recycle_items_request = dingtalkstorage__1__0_models.ListRecycleItemsRequest(
            next_token='next_token',
            max_results=30,
            union_id='chyxxxxx'
        )
        try:
            await client.list_recycle_items_with_options_async('recyclebin_id', list_recycle_items_request, list_recycle_items_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which 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\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\ListRecycleItemsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListRecycleItemsRequest;
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();
        $listRecycleItemsHeaders = new ListRecycleItemsHeaders([]);
        $listRecycleItemsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listRecycleItemsRequest = new ListRecycleItemsRequest([
            "nextToken" => "next_token",
            "maxResults" => 30,
            "unionId" => "chyxxxxx"
        ]);
        try {
            $client->listRecycleItemsWithOptions("recyclebin_id", $listRecycleItemsRequest, $listRecycleItemsHeaders, 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 the code and message attributes, which 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));
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 using 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
  }

  listRecycleItemsHeaders := &dingtalkstorage_1_0.ListRecycleItemsHeaders{}
  listRecycleItemsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listRecycleItemsRequest := &dingtalkstorage_1_0.ListRecycleItemsRequest{
    NextToken: tea.String("next_token"),
    MaxResults: tea.Int32(30),
    UnionId: tea.String("chyxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListRecycleItemsWithOptions(tea.String("recyclebin_id"), listRecycleItemsRequest, listRecycleItemsHeaders, &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 the code and message attributes, which 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 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 using 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 listRecycleItemsHeaders = new $dingtalkstorage_1_0.ListRecycleItemsHeaders({ });
    listRecycleItemsHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let listRecycleItemsRequest = new $dingtalkstorage_1_0.ListRecycleItemsRequest({
      nextToken: "next_token",
      maxResults: 30,
      unionId: "chyxxxxx",
    });
    try {
      await client.listRecycleItemsWithOptions("recyclebin_id", listRecycleItemsRequest, listRecycleItemsHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message attributes, which help with troubleshooting
      }

    }    
  }

}

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 using 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.ListRecycleItemsHeaders listRecycleItemsHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListRecycleItemsHeaders();
            listRecycleItemsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListRecycleItemsRequest listRecycleItemsRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListRecycleItemsRequest
            {
                NextToken = "next_token",
                MaxResults = 30,
                UnionId = "chyxxxxx",
            };
            try
            {
                client.ListRecycleItemsWithOptions("recyclebin_id", listRecycleItemsRequest, listRecycleItemsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which 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 the code and message attributes, which help with troubleshooting
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
recycleItemsArrayThe list of recycle items.
idStringThe recycle item ID.
spaceIdStringThe ID of the space where the original file or folder was located.
dentryIdStringThe ID of the original file or folder.
sizeLongThe size of the original file or folder, in bytes.
typeStringThe type. - FILE: file - FOLDER: folder
originalNameStringThe name of the original file or folder.
originalPathStringThe path of the original file or folder.
operatorIdStringThe unionId of the user who performed the deletion.
operatorTimeStringThe deletion time, in ISO 8601 format. Example: 2022-07-29T14:55Z.
nextTokenStringThe pagination cursor. A non-empty value indicates that more data is available.

Response body example

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

{
  "recycleItems" : [ {
    "id" : "2528xxxxx",
    "spaceId" : "8415xxxxx",
    "dentryId" : "6585xxxxx",
    "size" : 512,
    "type" : "FILE",
    "originalName" : "Test folder",
    "originalPath" : "./Test folder",
    "operatorId" : "chyxxxxx",
    "operatorTime" : "2022-01-01T10:00:00Z"
  } ],
  "nextToken" : "1660268242000:2528089682"
}

Error codes

If an error occurs when you call this API, look up the error message in the Global error codes document to find a solution.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
400paramError.recycleBinId%sParameter error - recycleBinId.
400paramError.maxResults%sParameter error - maxResults.
404recycleBinNotExist%sThe Recycle Bin does not exist.
500systemError%sSystem error.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timed out.