DingTalk Open Platform

https://open.dingtalk.com/document/
Admin
DingTalk Open Platform provides developers with comprehensive APIs and tools to build mini-programs,...
Tokens:14,027,311
Snippets:48,768
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Python 调用 start_instance_with_options 发起流程实例

Source: https://open.dingtalk.com/document/orgapp/api-startinstance-v2

Python 示例展示如何调用钉钉宜搭的 start_instance_with_options 接口发起流程实例。需要先设置 access token，并替换 app_type、system_token、user_id、form_uuid、process_code 等参数。同步和异步方法均包含错误处理，异常时检查 err.code 和 err.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.yida_2_0.client import Client as dingtalkyida_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.yida_2_0 import models as dingtalkyida__2__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() -> dingtalkyida_2_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkyida_2_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        start_instance_headers = dingtalkyida__2__0_models.StartInstanceHeaders()
        start_instance_headers.x_acs_dingtalk_access_token = '<your access token>'
        start_instance_request = dingtalkyida__2__0_models.StartInstanceRequest(
            app_type='APP_PBKT0MFBEBTDO8T7SLVP',
            system_token='hexxx',
            user_id='1731234567',
            language='zh_CN',
            form_uuid='FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB',
            form_data_json='{"textField_jcpm6agt": "单行","employeeField_jcos0sar": ["workno"]}',
            process_code='TPROC--EF6Y4xxx',
            department_id='18295',
            process_data='[{ 	"key": "__optionalApproval_node_ocltdztr2b1", 	"value": ["5014533041684350"] }, { 	"key": "__optionalApproval_node_ocltdztr2b3", 	"value": ["5014533041684350", "01536610064226180419"] }, { 	"key": "__optionalApproval_node_oclte07cwn1", 	"value": ["01432910392321237660"] }]',
            use_alias=False
        )
        try:
            client.start_instance_with_options(start_instance_request, start_instance_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()
        start_instance_headers = dingtalkyida__2__0_models.StartInstanceHeaders()
        start_instance_headers.x_acs_dingtalk_access_token = '<your access token>'
        start_instance_request = dingtalkyida__2__0_models.StartInstanceRequest(
            app_type='APP_PBKT0MFBEBTDO8T7SLVP',
            system_token='hexxx',
            user_id='1731234567',
            language='zh_CN',
            form_uuid='FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB',
            form_data_json='{"textField_jcpm6agt": "单行","employeeField_jcos0sar": ["workno"]}',
            process_code='TPROC--EF6Y4xxx',
            department_id='18295',
            process_data='[{ 	"key": "__optionalApproval_node_ocltdztr2b1", 	"value": ["5014533041684350"] }, { 	"key": "__optionalApproval_node_ocltdztr2b3", 	"value": ["5014533041684350", "01536610064226180419"] }, { 	"key": "__optionalApproval_node_oclte07cwn1", 	"value": ["01432910392321237660"] }]',
            use_alias=False
        )
        try:
            await client.start_instance_with_options_async(start_instance_request, start_instance_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:])

```

--------------------------------

### Java SDK example for starting upload transaction

Source: https://open.dingtalk.com/document/development/enable-upload-transaction

Java SDK example using DingTalkClient to call the upload transaction API. Sets agentId, fileSize, chunkNumbers, and HTTP method GET, then executes with accessToken.

```java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/file/upload/transaction");
OapiFileUploadTransactionRequest request = new OapiFileUploadTransactionRequest();
request.setAgentId("13xxxxx01");
request.setFileSize(1000L);
request.setChunkNumbers(1L);
request.setHttpMethod("GET");
OapiFileUploadTransactionResponse response = client.execute(request,accessToken);
```

--------------------------------

### StartInstance API examples in Go and Node.js

Source: https://open.dingtalk.com/document/isvapp/api-startinstance-v2

These are the official auto-generated SDK examples for the DingTalk Yida StartInstance API. They show how to initialize a client with a token and call StartInstanceWithOptions to start a process instance. The Go example uses the alibabacloud-go SDK, and the Node.js example uses the @alicloud/dingtalk SDK. Both require replacing the placeholder access token and other sample values with real ones.

```go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkyida_2_0  "github.com/alibabacloud-go/dingtalk/yida_2_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)


// Description:
// 
// 使用 Token 初始化账号Client
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkyida_2_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkyida_2_0.Client{}
  _result, _err = dingtalkyida_2_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  startInstanceHeaders := &dingtalkyida_2_0.StartInstanceHeaders{}
  startInstanceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  startInstanceRequest := &dingtalkyida_2_0.StartInstanceRequest{
    AppType: tea.String("APP_PBKT0MFBEBTDO8T7SLVP"),
    SystemToken: tea.String("hexxx"),
    UserId: tea.String("1731234567"),
    Language: tea.String("zh_CN"),
    FormUuid: tea.String("FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB"),
    FormDataJson: tea.String("{\"textField_jcpm6agt\": \"单行\",\"employeeField_jcos0sar\": [\"workno\"]}"),
    ProcessCode: tea.String("TPROC--EF6Y4xxx"),
    DepartmentId: tea.String("18295"),
    ProcessData: tea.String("[{ \t\"key\": \"__optionalApproval_node_ocltdztr2b1\", \t\"value\": [\"5014533041684350\"] }, { \t\"key\": \"__optionalApproval_node_ocltdztr2b3\", \t\"value\": [\"5014533041684350\", \"01536610064226180419\"] }, { \t\"key\": \"__optionalApproval_node_oclte07cwn1\", \t\"value\": [\"01432910392321237660\"] }]"),
    UseAlias: tea.Bool(false),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.StartInstanceWithOptions(startInstanceRequest, startInstanceHeaders, &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)
  }
}
```

```nodejs
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkyida_2_0 = require('@alicloud/dingtalk/yida_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * 使用 Token 初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkyida_2_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let startInstanceHeaders = new dingtalkyida_2_0.StartInstanceHeaders({ });
    startInstanceHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let startInstanceRequest = new dingtalkyida_2_0.StartInstanceRequest({
      appType: 'APP_PBKT0MFBEBTDO8T7SLVP',
      systemToken: 'hexxx',
      userId: '1731234567',
      language: 'zh_CN',
      formUuid: 'FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB',
      formDataJson: '{"textField_jcpm6agt": "单行","employeeField_jcos0sar": ["workno"]}',
      processCode: 'TPROC--EF6Y4xxx',
      departmentId: '18295',
      processData: '[{ \t"key": "__optionalApproval_node_ocltdztr2b1", \t"value": ["5014533041684350"] }, { \t"key": "__optionalApproval_node_ocltdztr2b3", \t"value": ["5014533041684350", "01536610064226180419"] }, { \t"key": "__optionalApproval_node_oclte07cwn1", \t"value": ["01432910392321237660"] }]',
      useAlias: false,
    });
    try {
      await client.startInstanceWithOptions(startInstanceRequest, startInstanceHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

--------------------------------

### HTTP request example for starting upload transaction

Source: https://open.dingtalk.com/document/development/enable-upload-transaction

HTTP GET request to start a file upload transaction. Requires access_token, agent_id, file_size, and chunk_numbers query parameters. Use curl or code simulation to avoid browser character escaping issues.

```http
GET https://oapi.dingtalk.com/file/upload/transaction?access_token=ACCESS_TOKEN&agent_id=AGENT_ID&file_size=FILE_SIZE&chunk_numbers=CHUNK_NUMBERS
```

--------------------------------

### 异步发起审批实例 (start_process_instance_with_options_async)

Source: https://open.dingtalk.com/document/isvapp/initiate-approval-new-1

异步发起审批实例，使用 start_process_instance_with_options_async 方法。需要先创建客户端并设置访问令牌，请求中包含表单值、审批人、抄送人等参数。异常处理中检查 err.code 和 err.message 以定位问题。

```python
    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        start_process_instance_headers = dingtalkworkflow__1__0_models.StartProcessInstanceHeaders()
        start_process_instance_headers.x_acs_dingtalk_access_token = '<your access token>'
        form_component_values_0details_0details_0 = dingtalkworkflow__1__0_models.StartProcessInstanceRequestFormComponentValuesDetailsDetails(
            id='PhoneField_IZI2LP8QF6O0',
            biz_alias='Phone',
            name='PhoneField',
            value='123xxxxxxxx',
            ext_value='总个数:1',
            component_type='PhoneField'
        )
        form_component_values_0details_0 = dingtalkworkflow__1__0_models.StartProcessInstanceRequestFormComponentValuesDetails(
            id='PhoneField_IZI2LP8QF6O0',
            biz_alias='Phone',
            name='PhoneField',
            value='123xxxxxxxx',
            ext_value='总个数:1',
            details=[
                form_component_values_0details_0details_0
            ]
        )
        form_component_values_0 = dingtalkworkflow__1__0_models.StartProcessInstanceRequestFormComponentValues(
            id='PhoneField_IZI2LP8QF6O0',
            biz_alias='myPhoneNumber',
            name='PhoneField',
            value='123xxxxxxxx',
            ext_value='总个数:1',
            component_type='PhoneField',
            details=[
                form_component_values_0details_0
            ]
        )
        target_select_actioners_0 = dingtalkworkflow__1__0_models.StartProcessInstanceRequestTargetSelectActioners(
            actioner_key='manual_1918_5cd3_xxxx_6a98',
            actioner_user_ids=[
                '26652461xxxx5992'
            ]
        )
        approvers_0 = dingtalkworkflow__1__0_models.StartProcessInstanceRequestApprovers(
            action_type='会签：AND；或签：OR；单人：NONE',
            user_ids=[
                'user1'
            ]
        )
        start_process_instance_request = dingtalkworkflow__1__0_models.StartProcessInstanceRequest(
            originator_user_id='manager432',
            process_code='PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-xxxx-1',
            dept_id=1,
            microapp_agent_id=41605932,
            approvers=[
                approvers_0
            ],
            cc_list=[
                'user1'
            ],
            cc_position='START、FINISH、START_FINISH',
            target_select_actioners=[
                target_select_actioners_0
            ],
            form_component_values=[
                form_component_values_0
            ]
        )
        try:
            await client.start_process_instance_with_options_async(start_process_instance_request, start_process_instance_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:])
```

--------------------------------

### Install Go SDK with go get

Source: https://open.dingtalk.com/document/development/download-the-server-side-sdk

Command to install the DingTalk OpenAPI Go SDK using go get.

```javascript
go get -u github.com/alibabacloud-go/dingtalk/
```

--------------------------------

### POST /v1.0/yida/processes/instances/start

Source: https://open.dingtalk.com/document/isvapp/initiate-the-approval-process

发起宜搭审批流程。调用此接口需要访问凭证，并传入应用类型、系统令牌、用户ID、表单数据等参数。

```APIDOC
## POST /v1.0/yida/processes/instances/start

### Description
发起宜搭审批流程到钉钉开放平台。

### Method
POST

### Endpoint
/v1.0/yida/processes/instances/start

### Parameters
#### Header Parameters
- **x-acs-dingtalk-access-token** (String) - Required - 调用该接口的访问凭证。企业内部应用通过获取企业内部应用的accessToken接口获取；第三方企业应用通过获取第三方应用授权企业的accessToken接口获取。

#### Request Body
- **appType** (String) - Required - 应用类型。
- **systemToken** (String) - Required - 系统令牌。
- **userId** (String) - Required - 用户ID。
- **language** (String) - Optional - 语言。
- **formUuid** (String) - Required - 表单UUID。
- **formDataJson** (String) - Required - 表单数据JSON。
- **processCode** (String) - Required - 流程编码。
- **departmentId** (String) - Optional - 部门ID。
- **processData** (String) - Optional - 流程数据。

### Request Example
{
  "appType" : "String",
  "systemToken" : "String",
  "userId" : "String",
  "language" : "String",
  "formUuid" : "String",
  "formDataJson" : "String",
  "processCode" : "String",
  "departmentId" : "String",
  "processData" : "String"
}

### Response
#### Success Response (200)
- 响应体未在文档中明确给出。

#### Response Example
无
```

--------------------------------

### Response Example for External Contact Get

Source: https://open.dingtalk.com/document/isvapp/obtains-the-external-contact-details-of-an-enterprise

Example response for the external contact get request. Contains the contact details such as name, mobile, email, and department information. Note the duplicate share_dept_ids field in the example.

```json
{
        "errcode":0,
        "result":{
                "share_user_ids":[
                        "66220007745510"
                ],
                "follower_user_id":"manager4220",
                "address":"北京",
                "share_dept_ids":[],
                "label_ids":[
                        1561077317
                ],
                "share_dept_ids": [
                     42xxxx36
                ],
                "mobile":"136***47616",
                "remark":"技术负责人",
                "title":"CFO",
                "userid":"011250026469774889",
                "company_name":"钉钉",
                "name":"王经理",
                "state_code":"86",
                "email":"zhang@example.com"
        },
        "request_id":"xrudojam4g8f"
}
```

--------------------------------

### 获取管理员应用管理权限示例

Source: https://open.dingtalk.com/document/development/obtains-the-administrator-s-microapplication-management-permission

Requests permission check via GET https://oapi.dingtalk.com/user/can_access_microapp. Requires access_token, appId, and userId. The Java and C# examples set HTTP method to GET; the Python and PHP examples use default GET.

```curl
curl -X GET "https://oapi.dingtalk.com/user/can_access_microapp" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c54ee841-199a-459e-8146-3d08c1830a10' \
-d 'appId=1' \
-d 'userId=1'
```

```java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/user/can_access_microapp");
OapiUserCanAccessMicroappRequest req = new OapiUserCanAccessMicroappRequest();
req.setAppId(1L);
req.setUserId("1");
req.setHttpMethod("GET");
OapiUserCanAccessMicroappResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
```

```python
import dingtalk.api

req=dingtalk.api.OapiUserCanAccessMicroappRequest("https://oapi.dingtalk.com/user/can_access_microapp")

req.appId=1
req.userId="1"
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
```

```php
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiUserCanAccessMicroappRequest;
$req->setAppId("1");
$req->setUserId("1");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/user/can_access_microapp");
```

```csharp
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/user/can_access_microapp");
OapiUserCanAccessMicroappRequest req = new OapiUserCanAccessMicroappRequest();
req.AppId = 1L;
req.UserId = "1";
req.SetHttpMethod("GET");
OapiUserCanAccessMicroappResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

--------------------------------

### POST /v1.0/yida/processes/instances/start

Source: https://open.dingtalk.com/document/orgapp/initiate-the-approval-process

调用本接口发起宜搭审批流程到钉钉开放平台。

```APIDOC
## POST /v1.0/yida/processes/instances/start

### Description
发起宜搭审批流程到钉钉开放平台。

### Method
POST

### Endpoint
/v1.0/yida/processes/instances/start

### Parameters
#### Header Parameters
- **x-acs-dingtalk-access-token** (String) - Required - 调用该接口的访问凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取；第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

#### Request Body
- **appType** (String) - Required - 应用类型。
- **systemToken** (String) - Required - 系统令牌。
- **userId** (String) - Required - 用户ID。
- **language** (String) - Optional - 语言。
- **formUuid** (String) - Required - 表单UUID。
- **formDataJson** (String) - Required - 表单数据JSON。
- **processCode** (String) - Required - 流程编码。
- **departmentId** (String) - Optional - 部门ID。
- **processData** (String) - Optional - 流程数据。

### Request Example
```json
{
  "appType" : "String",
  "systemToken" : "String",
  "userId" : "String",
  "language" : "String",
  "formUuid" : "String",
  "formDataJson" : "String",
  "processCode" : "String",
  "departmentId" : "String",
  "processData" : "String"
}
```

### Response
#### Success Response (200)
- **processInstanceId** (String) - 审批实例ID。

#### Response Example
```json
{
  "processInstanceId": "String"
}
```
```

--------------------------------

### Python: list_inspect_info_with_options example

Source: https://open.dingtalk.com/document/orgapp/obtain-inspection-and-maintenance-records

Python SDK example for calling list_inspect_info_with_options. Initializes a client with Token, sets the access token placeholder, and sends a request with page_number=1, page_size=10, a sample device UUID, and type='inspect'. Includes both synchronous and asynchronous main methods; errors are checked for code and message attributes.

```python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.devicemng_1_0.client import Client as dingtalkdevicemng_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.devicemng_1_0 import models as dingtalkdevicemng__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() -> dingtalkdevicemng_1_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdevicemng_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_inspect_info_headers = dingtalkdevicemng__1__0_models.ListInspectInfoHeaders()
        list_inspect_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_inspect_info_request = dingtalkdevicemng__1__0_models.ListInspectInfoRequest(
            page_number=1,
            page_size=10,
            device_uuid=[
                'deviceUuid-sdfsdf-sdfsdfsdf'
            ],
            type='inspect'
        )
        try:
            client.list_inspect_info_with_options(list_inspect_info_request, list_inspect_info_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()
        list_inspect_info_headers = dingtalkdevicemng__1__0_models.ListInspectInfoHeaders()
        list_inspect_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_inspect_info_request = dingtalkdevicemng__1__0_models.ListInspectInfoRequest(
            page_number=1,
            page_size=10,
            device_uuid=[
                'deviceUuid-sdfsdf-sdfsdfsdf'
            ],
            type='inspect'
        )
        try:
            await client.list_inspect_info_with_options_async(list_inspect_info_request, list_inspect_info_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:])
```

--------------------------------

### HTTP Request Example for Get Recycle Bin

Source: https://open.dingtalk.com/document/development/obtain-information-about-the-recycle-bin

HTTP request example for the Get Recycle Bin API. It uses the GET method with query parameters recycleBinScope, scopeId, and unionId, and includes the required x-acs-dingtalk-access-token header.

```HTTP
GET /v1.0/storage/recycleBins?recycleBinScope=ORG&scopeId=ding123xxxxx&unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
```

--------------------------------

### HTTP Request Example for Get Recycle Items

Source: https://open.dingtalk.com/document/development/gets-the-list-of-recycle-items

HTTP request example for the Get Recycle Items API. Uses the GET method with the recycleBinId, nextToken, maxResults, and unionId query parameters. The x-acs-dingtalk-access-token header is required.

```HTTP
GET /v1.0/storage/recycleBins/recyclebin_id/recycleItems?nextToken=next_token&maxResults=30&unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:access_token
Content-Type:application/json
```

--------------------------------

### PHP Example for GetSignInList

Source: https://open.dingtalk.com/document/isvapp/view-the-check-in-details-of-a-single-schedule

PHP SDK example to retrieve sign-in details. Requires an access token and handles exceptions.

```php
<?php

use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Dingtalk;
use AlibabaCloud\Tea\Utils\Utils;
use AlibabaCloud\Tea\Tea;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\GetSignInListHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\GetSignInListRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Dingtalk
     * @throws Exception
     */
    public static function createClient() {
        $config = new \AlibabaCloud\Tea\Config\Config();
        $config->protocol = 'https';
        $config->regionId = 'central';
        return new Dingtalk($config);
    }

    public static function main($args) {
        $client = self::createClient();
        $getSignInListHeaders = new GetSignInListHeaders();
        $getSignInListHeaders->xAcsDingtalkAccessToken = '<your access token>';
        $getSignInListRequest = new GetSignInListRequest([
            'maxResults' => 25,
            'nextToken' => 'cnNTbxxx',
            'type' => 'sign_in'
        ]);
        try {
            $client->getSignInListWithOptions('iiiP35sxxx', 'primary', 'cnNTbWxxx', $getSignInListRequest, $getSignInListHeaders, new RuntimeOptions([]));
        } catch (\Exception $err) {
            if (!Utils::empty($err->getCode()) && !Utils::empty($err->getMessage())) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }
        }
    }
}

Sample::main($argv);
```

--------------------------------

### POST /v2.0/yida/processes/instances/start

Source: https://open.dingtalk.com/document/isvapp/api-startinstance-v2

发起宜搭审批流程到钉钉开放平台。需要宜搭流程数据写权限。

```APIDOC
## [POST] /v2.0/yida/processes/instances/start

### Description
发起宜搭审批流程到钉钉开放平台。

### Method
POST

### Endpoint
/v2.0/yida/processes/instances/start

### Parameters
#### Header Parameters
- **x-acs-dingtalk-access-token** (String) - Required - 调用该接口的访问凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取；第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

#### Request Body
- **appType** (String) - Required - 应用标识。
- **systemToken** (String) - Required - 系统令牌。
- **userId** (String) - Required - 用户标识。
- **language** (String) - Optional - 语言。
- **formUuid** (String) - Required - 表单标识。
- **formDataJson** (String) - Required - 表单数据JSON。
- **processCode** (String) - Required - 流程编码。
- **departmentId** (String) - Optional - 部门标识。
- **processData** (String) - Optional - 流程数据。
- **useAlias** (Boolean) - Optional - 是否使用别名。

### Request Example
```json
{
  "appType" : "String",
  "systemToken" : "String",
  "userId" : "String",
  "language" : "String",
  "formUuid" : "String",
  "formDataJson" : "String",
  "processCode" : "String",
  "departmentId" : "String",
  "processData" : "String",
  "useAlias" : Boolean
}
```

### Response
#### Success Response (200)
- **result** (String) - 发起结果。

#### Response Example
```json
{
  "result": "String"
}
```
```

--------------------------------

### Response Example for Get User Details

Source: https://open.dingtalk.com/document/orgapp/query-user-details

Example response from the DingTalk API for the get user details request. Shows the structure of the returned user information.

```json
{
        "errcode":"0",
        "result":{
                "extension":"{\"爱好\":\"旅游\",\"年龄\":\"24\"}",
                "unionid":"z21HjQliSzpw0YWxxxxx",
                "boss":"true",
                "role_list":{
                        "group_name":"职务",
                        "name":"总监",
                        "id":"100"
                },
                "exclusive_account":false,
                "manager_userid":"manager240",
                "admin":"true",
                "remark":"备注备注",
                "title":"技术总监",
                "hired_date":"1597573616828",
                "userid":"zhangsan",
                "work_place":"未来park",
                "dept_order_list":{
                        "dept_id":"2",
                        "order":"1"
                },
                "real_authed":"true",
                "dept_id_list":"[2,3,4]",
                "job_number":"4",
                "email":"test@xxx.com",
                "leader_in_dept":{
                        "leader":"true",
                        "dept_id":"2"
                },
                "mobile":"18513027676",
                "active":"true",
                "org_email":"test@xxx.com",
                "telephone":"010-86123456-2345",
                "avatar":"xxx",
                "hide_mobile":"false",
                "senior":"true",
                "name":"张三",
                "union_emp_ext":{
                        "union_emp_map_list":{
                                "userid":"5000",
                                "corp_id":"dingxxx"
                        },
                        "userid":"500",
                        "corp_id":"dingxxx"
                },
                "state_code":"86"
        },
        "errmsg":"ok"
}
```

--------------------------------

### Response Example for DingTalk Article Get

Source: https://open.dingtalk.com/document/orgapp/get-articles

Example JSON response from the article get API. Contains article details such as content, title, and publish status.

```json
{
        "article_id": 114001, 
        "content": "<html><div>abc</div></html>", 
        "create_time": 1442027997327, 
        "digest": "摘要1", 
        "errcode": 0, 
        "publish_status": 1, 
        "publish_time": 1442027997327, 
        "thumb_media_id": "@lALPBbCc1XuaP_rNAljNAlg", 
        "title": "标题1", 
        "update_time": 1442027997327, 
        "url": "https://contentcenter.dingtalk.com?articleId=17001", 
        "request_id": "5dlbspcstarj"
}
```

--------------------------------

### POST /v2.0/yida/processes/instances/start

Source: https://open.dingtalk.com/document/orgapp/api-startinstance-v2

发起宜搭审批流程。需要提供访问令牌和请求体参数，包括appType、systemToken、userId等。

```APIDOC
## [POST] /v2.0/yida/processes/instances/start

### Description
发起宜搭审批流程到钉钉开放平台。

### Method
POST

### Endpoint
/v2.0/yida/processes/instances/start

### Parameters
#### Header Parameters
- **x-acs-dingtalk-access-token** (String) - Required - 调用该接口的访问凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取；第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

#### Request Body
- **appType** (String) - Required - 应用类型。
- **systemToken** (String) - Required - 系统令牌。
- **userId** (String) - Required - 用户ID。
- **language** (String) - Optional - 语言。
- **formUuid** (String) - Required - 表单UUID。
- **formDataJson** (String) - Required - 表单数据JSON。
- **processCode** (String) - Required - 流程编码。
- **departmentId** (String) - Optional - 部门ID。
- **processData** (String) - Optional - 流程数据。
- **useAlias** (Boolean) - Optional - 是否使用别名。

### Request Example
{
  "appType" : "String",
  "systemToken" : "String",
  "userId" : "String",
  "language" : "String",
  "formUuid" : "String",
  "formDataJson" : "String",
  "processCode" : "String",
  "departmentId" : "String",
  "processData" : "String",
  "useAlias" : true
}

### Response
#### Success Response (200)
- **status** (String) - 请求状态。
- **result** (Object) - 返回结果。

#### Response Example
{
  "status": "success",
  "result": {}
}
```

--------------------------------

### start_instance_with_options

Source: https://open.dingtalk.com/document/orgapp/api-startinstance-v2

Starts a process instance synchronously using the provided request and headers.

```APIDOC
## start_instance_with_options

### Description
Starts a process instance synchronously using the provided request and headers.

### Method
POST

### Endpoint
/startInstance

### Parameters
#### Request Body
- **app_type** (string) - Required - The application type identifier.
- **system_token** (string) - Required - The system token for authentication.
- **user_id** (string) - Required - The ID of the user initiating the process.
- **language** (string) - Optional - The language for the process (e.g., 'zh_CN').
- **form_uuid** (string) - Required - The UUID of the form.
- **form_data_json** (string) - Required - JSON string containing form field values.
- **process_code** (string) - Required - The code of the process to start.
- **department_id** (string) - Optional - The department ID.
- **process_data** (string) - Optional - JSON string containing process data.
- **use_alias** (boolean) - Optional - Whether to use alias for fields.

#### Headers
- **x_acs_dingtalk_access_token** (string) - Required - Access token for authentication.

### Request Example
```json
{
  "app_type": "APP_PBKT0MFBEBTDO8T7SLVP",
  "system_token": "hexxx",
  "user_id": "1731234567",
  "language": "zh_CN",
  "form_uuid": "FORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB",
  "form_data_json": "{\"textField_jcpm6agt\": \"单行\",\"employeeField_jcos0sar\": [\"workno\"]}",
  "process_code": "TPROC--EF6Y4xxx",
  "department_id": "18295",
  "process_data": "[{ \"key\": \"__optionalApproval_node_ocltdztr2b1\", \"value\": [\"5014533041684350\"] }, { \"key\": \"__optionalApproval_node_ocltdztr2b3\", \"value\": [\"5014533041684350\", \"01536610064226180419\"] }, { \"key\": \"__optionalApproval_node_oclte07cwn1\", \"value\": [\"01432910392321237660\"] }]",
  "use_alias": false
}
```

### Response
#### Success Response (200)
No response body is documented.

#### Error Response
- **code** (string) - Error code.
- **message** (string) - Error message.

```

--------------------------------

### HTTP Request Example for Get User Attribute Visibility Settings

Source: https://open.dingtalk.com/document/development/pull-hidden-property-field-for-enterprise-employees

HTTP request example for the Get User Attribute Visibility Settings API. Uses the GET method with query parameters nextToken and maxResults. Requires the x-acs-dingtalk-access-token header.

```HTTP
GET /v1.0/contact/staffAttributes/visibilitySettings?nextToken=-1&maxResults=10 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:aec2bd0xxx
Content-Type:application/json
```

--------------------------------

### GET /v2.0/wiki/workspaces

Source: https://open.dingtalk.com/document/orgapp/get-knowledge-base-list

This snippet documents the GET /v2.0/wiki/workspaces endpoint, which retrieves a list of wiki workspaces. It includes the HTTP request example and the Java SDK example for calling the endpoint.

```APIDOC
## GET /v2.0/wiki/workspaces

### Description
Retrieves a list of wiki workspaces. This endpoint allows you to paginate through workspaces, sort them, and optionally include permission role information.

### Method
GET

### Endpoint
/v2.0/wiki/workspaces

### Parameters
#### Query Parameters
- **nextToken** (string) - Optional - The pagination token for the next page of results.
- **maxResults** (integer) - Optional - The maximum number of results to return per page.
- **orderBy** (string) - Optional - The sorting order for the results. Example: VIEW_TIME_DESC.
- **withPermissionRole** (boolean) - Optional - Whether to include permission role information in the response.
- **operatorId** (string) - Required - The ID of the operator performing the request.

### Request Example
```http
GET /v2.0/wiki/workspaces?nextToken=next_token&maxResults=30&orderBy=VIEW_TIME_DESC&withPermissionRole=false&operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host: api.dingtalk.com
x-acs-dingtalk-access-token: access_token
Content-Type: application/json
```

### Response
#### Success Response (200)
- **workspaces** (array) - List of workspace objects.
- **nextToken** (string) - Pagination token for the next page.

#### Response Example
```json
{
  "workspaces": [
    {
      "workspaceId": "string",
      "name": "string"
    }
  ],
  "nextToken": "string"
}
```
```
Tokens:
Raw