DingTalk Open Platform

https://open.dingtalk.com/
Admin
DingTalk Open Platform is a comprehensive development platform that provides APIs, SDKs, and tools...
Tokens:3,668,048
Snippets:18,620
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Python SDK Example for Querying Attendance Machine

Source: https://open.dingtalk.com/document/orgapp/query-attendance-machine-information

Use the DingTalk Python SDK to get attendance machine details. This includes both synchronous and asynchronous methods. Ensure you have the SDK installed and an access token.

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

from typing import List

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

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_machine_headers = dingtalkattendance__1__0_models.GetMachineHeaders()
        get_machine_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            client.get_machine_with_options('236847095', get_machine_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()
        get_machine_headers = dingtalkattendance__1__0_models.GetMachineHeaders()
        get_machine_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            await client.get_machine_with_options_async('236847095', get_machine_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:])
```

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

### Start Process Instance with Options (Go)

Source: https://open.dingtalk.com/document/orgapp/create-an-approval-instance

Initiates a process instance using the provided request, headers, and runtime options. Handles potential errors during the process start.

```go
    _, _err = client.StartProcessInstanceWithOptions(startProcessInstanceRequest, startProcessInstanceHeaders, &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)
  }
}
```

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

### HTTP GET Request Example

Source: https://open.dingtalk.com/document/isvapp/user-information-obtained-through-logon-free-code-not-recommended

This is an example of an HTTP GET request to the `user/getuserinfo` endpoint. It requires an `access_token` and a `code` as query parameters.

```http
GET https://oapi.dingtalk.com/user/getuserinfo?access_token=ACCESS_TOKEN&code=123456
```

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

### Initiate a Signed Task in C#

Source: https://open.dingtalk.com/document/orgapp/obtain-the-address-used-to-initiate-a-signed-task

This example shows how to configure the client, set up the process request with participant and file details, and execute the process start operation.

```csharp
// 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.Dingtalkesign_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkesign_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkesign_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartHeaders processStartHeaders = new AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartHeaders();
            processStartHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestSourceInfo sourceInfo = new AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestSourceInfo
            {
                ShowText = "审批信息",
                PcUrl = "https: //dingsign.esign.cn/contract",
                MobileUrl = "https: //dingsign.esign.cn/contract",
            };
            AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestCcs ccs0 = new AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestCcs
            {
                AccountType = "OUTER_USER",
                UserId = "user456",
                Account = "13567394099",
                AccountName = "赵xx",
                OrgName = "杭州xx",
            };
            AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestParticipants participants0 = new AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestParticipants
            {
                AccountType = "DING_USER",
                SignRequirements = "1",
                UserId = "user456",
                Account = "17770164159",
                AccountName = "赵xx",
                OrgName = "杭州xx",
            };
            AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestFiles files0 = new AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestFiles
            {
                FileId = "5b500xxx",
                FileName = "劳动合同.pdf",
            };
            AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest processStartRequest = new AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest
            {
                AutoStart = "false",
                InitiatorUserId = "user456",
                TaskName = "xxx发起的流程",
                RedirectUrl = "https: //dingsign.esign.cn/contract",
                Files = new List<AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestFiles>
                {
                    files0
                },
                Participants = new List<AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestParticipants>
                {
                    participants0
                },
                Ccs = new List<AlibabaCloud.SDK.Dingtalkesign_2_0.Models.ProcessStartRequest.ProcessStartRequestCcs>
                {
                    ccs0
                },
                SourceInfo = sourceInfo,
            };
            try
            {
                client.ProcessStartWithOptions(processStartRequest, processStartHeaders, 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 属性，可帮助开发定位问题
                }
            }
        }


    }
}
```

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

### Request Example: GET /v1.0/microApp/allApps

Source: https://open.dingtalk.com/document/orgapp/obtains-a-list-of-all-enterprise-applications

This is an example of an HTTP GET request to retrieve all enterprise applications. Ensure the 'x-acs-dingtalk-access-token' header is correctly set.

```http
GET /v1.0/microApp/allApps HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:String
Content-Type:application/json
```

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

### Initialize and Query Document Creation Summary in C#

Source: https://open.dingtalk.com/document/orgapp/queries-the-number-dingtalk-documents-created-per-day-in-an

This C# example demonstrates how to create a client using an access token and call the GetDocCreatedSummaryWithOptions method to fetch document creation data.

```csharp
// 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.Dingtalkexclusive_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkexclusive_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkexclusive_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkexclusive_1_0.Models.GetDocCreatedSummaryHeaders getDocCreatedSummaryHeaders = new AlibabaCloud.SDK.Dingtalkexclusive_1_0.Models.GetDocCreatedSummaryHeaders();
            getDocCreatedSummaryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            try
            {
                client.GetDocCreatedSummaryWithOptions("20210801", getDocCreatedSummaryHeaders, 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 GET Request Example

Source: https://open.dingtalk.com/document/orgapp/obtains-statistics-on-user-activation-status

This snippet shows an example of an HTTP GET request to query active user statistical data. It includes the endpoint, host, and necessary headers.

```HTTP
GET /v1.0/datacenter/activeUserData?statDate=20210620 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:85dd6axxx
Content-Type:application/json
```

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

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

Source: https://open.dingtalk.com/document/isvapp/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 - 调用该接口的访问凭证。

#### Request Body
- **appType** (String) - Required - 应用编码。
- **systemToken** (String) - Required - 应用秘钥。
- **userId** (String) - Required - 用户的userid。
- **language** (String) - Optional - 语言，取值：zh_CN（默认值）、en_US。
- **formUuid** (String) - Required - 表单唯一编码。
- **formDataJson** (String) - Required - 表单数据。
- **processCode** (String) - Optional - 流程编码。
- **departmentId** (String) - Optional - 发起人所在部门ID。
- **processData** (String) - Optional - 发起人自选节点所选的审批人信息。

### Request Example
{
"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" : "[{\"key\": \"__optionalApproval_node_ocltdztr2b1\", \"value\": [\"5014533041684350\"]}, {\"key\": \"__optionalApproval_node_ocltdztr2b3\", \"value\": [\"5014533041684350\", \"01536610064226180419\"]}, {\"key\": \"__optionalApproval_node_oclte07cwn1\", \"value\": [\"01432910392321237660\"]}]"
}

### Response
#### Success Response (200)
- **result** (String) - 流程实例ID。
```

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

### Java SDK Example for Multiple Process Instances

Source: https://open.dingtalk.com/document/orgapp/queries-multiple-process-instances

Java code demonstrating how to initialize the client and call the getInstancesByIdListWithOptions method.

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

import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkyida_1_0.*;
import com.aliyun.dingtalkyida_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkyida_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkyida_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkyida_1_0.Client client = Sample.createClient();
        GetInstancesByIdListHeaders getInstancesByIdListHeaders = new GetInstancesByIdListHeaders();
        getInstancesByIdListHeaders.xAcsDingtalkAccessToken = "<your access token>";
        GetInstancesByIdListRequest getInstancesByIdListRequest = new GetInstancesByIdListRequest()
                .setAppType("APP_PBKTxxx")
                .setSystemToken("hexxxx")
                .setUserId("manager123")
                .setLanguage("zh_CN")
                .setProcessInstanceIds("inst-123,inst-223");
        try {
            client.getInstancesByIdListWithOptions(getInstancesByIdListRequest, getInstancesByIdListHeaders, new 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 属性，可帮助开发定位问题
            }

        }        
    }
}
```

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

### Get Recycle Items List Request Example

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

This is an example of the HTTP request to get a list of recycle items. It includes query parameters for pagination and the operator's union ID.

```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
```

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

### Example JSON Response for Get Dentry ID by UUID

Source: https://open.dingtalk.com/document/development/api-getdentryidbyuuid

This is an example of a successful JSON response when calling the API to get a dentry ID by its UUID. It contains the dentryUuid, dentryId, and spaceId.

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

{
  "dentryUuid" : "Qnp9zOxxxxLK0g6l",
  "dentryId" : "1744xxxx2000",
  "spaceId" : "490xxxx976"
}
```

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

### Initialize and Query Document Creation Summary in C++

Source: https://open.dingtalk.com/document/orgapp/queries-the-number-dingtalk-documents-created-per-day-in-an

This C++ example shows how to configure the client and invoke the getDocCreatedSummaryWithOptions API to retrieve document creation statistics.

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

#include <alibabacloud/dingtalkexclusive__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>

using namespace std;

Alibabacloud_Dingtalkexclusive_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkexclusive_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args++;
  shared_ptr<Alibabacloud_Dingtalkexclusive_1_0::Client> client = make_shared<Alibabacloud_Dingtalkexclusive_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkexclusive_1_0::GetDocCreatedSummaryHeaders> getDocCreatedSummaryHeaders = make_shared<Alibabacloud_Dingtalkexclusive_1_0::GetDocCreatedSummaryHeaders>();
  getDocCreatedSummaryHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  try {
    client->getDocCreatedSummaryWithOptions(make_shared<string>("20210801"), getDocCreatedSummaryHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err 中含有 code 和 message 属性，可帮助开发定位问题
    }
  }
}
```

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

### HTTP Request Example

Source: https://open.dingtalk.com/document/development/the-union-id-that-you-want-to-query-you-can

Example of an HTTP GET request to query the migrated UnionID.

```HTTP
GET /v1.0/contact/orgAccount/getMigrationUnionIdByUnionIds?unionId=yyyy HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:BExxxx
Content-Type:application/json
```

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

### processStartWithOptions

Source: https://open.dingtalk.com/document/orgapp/obtain-the-address-used-to-initiate-a-signed-task

Initiates a signing process by providing task details, participants, files, and source information.

```APIDOC
## SDK Method: processStartWithOptions

### Description
Initiates a new signing process task. This method requires an access token and a request object containing task configuration, file details, and participant information.

### Parameters
- **processStartRequest** (Object) - Required - The request object containing task details such as initiatorUserId, taskName, files, participants, and ccs.
- **processStartHeaders** (Object) - Required - Headers containing the xAcsDingtalkAccessToken.
- **runtimeOptions** (Object) - Required - Runtime configuration options.

### Response
- **taskId** (String) - The unique identifier for the created task.
- **pcUrl** (String) - The URL for the task on PC.
- **mobileUrl** (String) - The URL for the task on mobile.

### Response Example
{
  "taskId" : "65A86D2Bxxx",
  "pcUrl" : "https://developers.dingtalk.com/",
  "mobileUrl" : "https://developers.dingtalk.com/"
}
```

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

### Initialize Client and Get Flow Details in C++

Source: https://open.dingtalk.com/document/orgapp/obtains-the-task-details

Demonstrates how to configure the client and call getFlowDetailWithOptions using the C++ SDK.

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

#include <alibabacloud/dingtalkesign__2__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>

using namespace std;

Alibabacloud_Dingtalkesign_2_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkesign_2_0::Client(config);
}

int main(int argc, char *args[]) {
  args++;
  shared_ptr<Alibabacloud_Dingtalkesign_2_0::Client> client = make_shared<Alibabacloud_Dingtalkesign_2_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkesign_2_0::GetFlowDetailHeaders> getFlowDetailHeaders = make_shared<Alibabacloud_Dingtalkesign_2_0::GetFlowDetailHeaders>();
  getFlowDetailHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  try {
    client->getFlowDetailWithOptions(make_shared<string>("PRO-E990Dxxx"), getFlowDetailHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err 中含有 code 和 message 属性，可帮助开发定位问题
    }
  }
}
```

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

### Get Sign Detail Response Example

Source: https://open.dingtalk.com/document/orgapp/get-the-details-of-process-signing

Example of the JSON response returned by the GetSignDetail API.

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

{
  "businessScene" : "业务场景",
  "flowStatus" : 1,
  "signers" : [ {
    "signStatus" : 1,
    "signerName" : "签署人"
  } ]
}
```

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

### Initialize and Request Access Token in PHP

Source: https://open.dingtalk.com/document/orgapp/obtain-the-access_token-of-an-internal-app

Shows client setup and token request execution in PHP, including error handling with TeaError.

```php
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\\SDK\\Sample;

use AlibabaCloud\\SDK\\Dingtalk\\Voauth2_1_0\\Dingtalk;
use \\Exception;
use AlibabaCloud\\Tea\\Exception\\TeaError;
use AlibabaCloud\\Tea\\Utils\\Utils;

use Darabonba\\OpenApi\\Models\\Config;
use AlibabaCloud\\SDK\\Dingtalk\\Voauth2_1_0\\Models\\GetAccessTokenRequest;

class Sample {

    /**
     * 使用 Token 初始化账号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();
        $getAccessTokenRequest = new GetAccessTokenRequest([
            "appKey" => "dingeqqpkv3xxxxxx",
            "appSecret" => "GT-lsu-taDAxxxsTsxxxx"
        ]);
        try {
            $client->getAccessToken($getAccessTokenRequest);
        }
        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));
```

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

### Get File Versions Request Example

Source: https://open.dingtalk.com/document/development/obtains-a-list-of-file-versions

This example demonstrates how to construct a GET request to retrieve file versions. Ensure you include the necessary access token and parameters like spaceId, dentryId, nextToken, maxResults, and unionId.

```HTTP
GET /v1.0/storage/spaces/854xxxxx/dentries/668xxxxx/versions?nextToken=next_token&maxResults=30&unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
```

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

### HTTP GET Request for Paging Query

Source: https://open.dingtalk.com/document/orgapp/intelligent-customer-service-paging-query-work-order

An example of an HTTP GET request to query work orders with pagination parameters.

```HTTP
GET /v1.0/customerService/tickets?openInstanceId=default&productionType=1&templateId=42&ticketId=2050000012047051&sourceId=4d75dd75-f2bd-4621-b93f-4c317f137cf2&foreignId=202101&ticketStatus=1&startTime=1619507898000&endTime=1622188240376&nextToken=0&maxResults=10 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:11111111
Content-Type:application/json
```

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

### Query Process Instance Java Client

Source: https://open.dingtalk.com/document/orgapp/queries-a-process-instance-based-on-its-id

A Java example demonstrating how to initialize the client and call the getInstanceByIdWithOptions method.

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

import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkyida_1_0.*;
import com.aliyun.dingtalkyida_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkyida_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkyida_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkyida_1_0.Client client = Sample.createClient();
        GetInstanceByIdHeaders getInstanceByIdHeaders = new GetInstanceByIdHeaders();
        getInstanceByIdHeaders.xAcsDingtalkAccessToken = "<your access token>";
        GetInstanceByIdRequest getInstanceByIdRequest = new GetInstanceByIdRequest()
                .setAppType("APP_PBKT0xxx")
                .setSystemToken("hexxxx")
                .setUserId("manager123")
                .setLanguage("zh_CN");
        try {
            client.getInstanceByIdWithOptions("f30233fb-72e1-xxx", getInstanceByIdRequest, getInstanceByIdHeaders, new 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 属性，可帮助开发定位问题
            }

        }        
    }
}
```

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

### Quick Start: Select Contacts Example

Source: https://open.dingtalk.com/document/dingstart/webapp-read-before-development

This example demonstrates the complete process of selecting contacts using the SDK, including permission requests, API calls, result handling, and error listening.

```APIDOC
import * as dd from 'dingtalk-jsapi';

// 1. Request permission (recommended to get it early on page load)
async function requestPermission() {
  try {
    const authCode = await dd.runtime.permission.requestAuthCode({
      corpId: 'your_corp_id', // Enterprise ID, required for multi-enterprise scenarios
    });
    console.log('Authorization successful, authCode:', authCode);
  } catch (error) {
    console.error('Permission request failed:', error);
    alert('Please grant authorization to continue');
  }
}

// 2. Call the select contacts function
async function selectContacts() {
  try {
    // Use the officially recommended three-part call
    const result = await dd.biz.contact.choose({
      startWithOrg: true,        // Whether to show the organization structure
      multiple: true,            // Whether to allow multiple selections
      users: [ ],                 // Default selected users
      disabledUsers: [ ],         // Users who cannot be selected
      title: 'Select Collaboration Members'       // Page title
    });

    // 3. Process the returned result
    if (result && result.users && result.users.length > 0) {
      console.log('Selected contacts:', result.users);
      alert(`Selected ${result.users.length} members`);
    } else {
      console.log('User did not select any contacts');
    }
  } catch (error) {
    // 4. Error listening and handling
    switch (error.errCode) {
      case 12:
        console.warn('User cancelled operation');
        break;
      case 10:
        console.error('Insufficient permissions, please check application configuration');
        break;
      default:
        console.error('Unknown error:', error);
    }
  }
}

// Request permission when the page initializes
requestPermission();

// Trigger contact selection (e.g., bind to a button click event)
document.getElementById('selectBtn').addEventListener('click', selectContacts);
```

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

### Project Application Installation Event Data

Source: https://open.dingtalk.com/document/development/teamposition-application-change-event

Provides an example of the biz_data structure for a project application installation event. This data is used when a new application is installed within a project.

```json
{
  "data": {
    "syncAction": "project_project_app_changed",
    "eventSubType": "tb.v3.project.application.create",
    "creatorId": "0715153011125xxxx",
    "projectId": "64ba333e4206372f3f5cxxxx",
    "created": "2022-12-26T09:27:43.733Z",
    "updated": "2022-12-26T09:27:43.733Z",
    "applicationId": "64ba333e4206372f3f5cxxxx"
  }
}
```

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

### Get dentry ID by UUID (HTTP)

Source: https://open.dingtalk.com/document/development/api-getdentryidbyuuid

Example of an HTTP GET request to retrieve the dentry ID using the dentryUuid and operatorId.

```HTTP
GET /v2.0/doc/dentries/Qnp9xxxxDK0g6l/queryDentryId?operatorId=E9CS6xxxx7QiEiE HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:873dxxxx9380ad
Content-Type:application/json
```

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

### ProcessStartWithOptions

Source: https://open.dingtalk.com/document/orgapp/obtain-the-address-used-to-initiate-a-signed-task

Initiates a signing process using the provided request parameters and headers.

```APIDOC
## ProcessStartWithOptions

### Description
Initiates a signing process by sending a request to the DingTalk eSign service. This method requires an access token and specific process details including files, participants, and source information.

### Parameters
- **processStartRequest** (ProcessStartRequest) - Required - The request object containing process details like TaskName, Files, Participants, and SourceInfo.
- **processStartHeaders** (ProcessStartHeaders) - Required - The headers object containing the X-Acs-Dingtalk-AccessToken.
- **runtimeOptions** (RuntimeOptions) - Required - Runtime configuration options.

### Request Example
```go
processStartRequest := &dingtalkesign_2_0.ProcessStartRequest{
  AutoStart: tea.String("false"),
  InitiatorUserId: tea.String("user456"),
  TaskName: tea.String("xxx发起的流程"),
  RedirectUrl: tea.String("https: //dingsign.esign.cn/contract"),
  Files: []*dingtalkesign_2_0.ProcessStartRequestFiles{files0},
  Participants: []*dingtalkesign_2_0.ProcessStartRequestParticipants{participants0},
  Ccs: []*dingtalkesign_2_0.ProcessStartRequestCcs{ccs0},
  SourceInfo: sourceInfo,
}
```
```

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

### HTTP Request Example

Source: https://open.dingtalk.com/document/development/api-getuuidbydentryid

Example of an HTTP GET request to query dentryUuid. Ensure the Host and x-acs-dingtalk-access-token headers are correctly set.

```HTTP
GET /v2.0/doc/dentries/1744xxxx000/queryDentryUuid?spaceId=490xxxx76&operatorId=E9CS6xxxxN7QiEiE HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:873d8xxxx9380ad
Content-Type:application/json
```

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

### Initialize Stream Client

Source: https://open.dingtalk.com/document/development/develop-stream-mode-push-server

Basic setup for a Stream client using credentials to register event handlers.

```go
func main() {
  e := clientV2.
    NewBuilder().
    Credential(&clientV2.AuthClientCredential{ClientId: "${clientId}", ClientSecret: "${clientSecret}"}).
    //监听开放平台事件
    RegisterAllEventHandler(func(event *clientV2.GenericOpenDingTalkEvent) clientV2.EventStatus {
      println("receive event ", event.Data)
      //成功返回 clientV2.EventStatusSuccess,失败返回clientV2.EventStatusLater
      return clientV2.EventStatusSuccess
    }).
    Build().
    Start(context.Background())
	
  if e != nil {
    println("failed to start stream client", e.Error())
    return
  }

  select {}
}
```

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

### Initialize and Use DingTalk Client

Source: https://open.dingtalk.com/document/isvapp/asynchronous-address-book-file-content-translation

Examples for setting up the DingTalk client and calling the TranslateFile API.

```go
func CreateClient () (_result *dingtalkcontact_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkcontact_1_0.Client{}
  _result, _err = dingtalkcontact_1_0.NewClient(config)
  return _result, _err
}

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

  translateFileHeaders := &dingtalkcontact_1_0.TranslateFileHeaders{}
  translateFileHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  medias := map[string]*string{
    "key": tea.String("xxxx"),
  }
  translateFileRequest := &dingtalkcontact_1_0.TranslateFileRequest{
    Medias: medias,
    OutputFileName: tea.String("学习手册"),
    UnionId: tea.String("fXRUNxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.TranslateFileWithOptions(translateFileRequest, translateFileHeaders, &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
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcontact_1_0, * as $dingtalkcontact_1_0 from '@alicloud/dingtalk/contact_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(): dingtalkcontact_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkcontact_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let translateFileHeaders = new $dingtalkcontact_1_0.TranslateFileHeaders({ });
    translateFileHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let medias = {
      key: "xxxx",
    };
    let translateFileRequest = new $dingtalkcontact_1_0.TranslateFileRequest({
      medias: medias,
      outputFileName: "学习手册",
      unionId: "fXRUNxxx",
    });
    try {
      await client.translateFileWithOptions(translateFileRequest, translateFileHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

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

```csharp
// 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.Dingtalkcontact_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.TranslateFileHeaders translateFileHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.TranslateFileHeaders();
            translateFileHeaders.XAcsDingtalkAccessToken = "<your access token>";
            Dictionary<string, string> medias = new Dictionary<string, string>
            {
                {"key", "xxxx"},
            };
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.TranslateFileRequest translateFileRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.TranslateFileRequest
            {
                Medias = medias,
                OutputFileName = "学习手册",
                UnionId = "fXRUNxxx",
            };
            try
            {
                client.TranslateFileWithOptions(translateFileRequest, translateFileHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
```

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

### HTTP GET Request for Employee Type Statistics

Source: https://open.dingtalk.com/document/orgapp/obtains-statistics-on-employee-types

An example of an HTTP GET request to retrieve employee type data for a specific date.

```HTTP
GET /v1.0/datacenter/employeeTypeData?statDate=20210620 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:85dd6xxx
Content-Type:application/json
```

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

### Initialize AI Interaction Client in Go

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

Shows the configuration and client instantiation process for the Go SDK.

```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"
  dingtalkaiinteraction_1_0  "github.com/alibabacloud-go/dingtalk/aiInteraction_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 *dingtalkaiinteraction_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkaiinteraction_1_0.Client{}
  _result, _err = dingtalkaiinteraction_1_0.NewClient(config)
  return _result, _err
}
```

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

### HTTP Request Example

Source: https://open.dingtalk.com/document/orgapp/query-data-of-inactive-users

This is an example of an HTTP POST request to the inactive user get API. Ensure you replace ACCESS_TOKEN with your valid token.

```http
POST https://oapi.dingtalk.com/topapi/inactive/user/get?access_token=ACCESS_TOKEN
```

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

### Initialize Client and Get Flow Details in C#

Source: https://open.dingtalk.com/document/orgapp/obtains-the-task-details

Demonstrates how to configure the client with a token and call GetFlowDetailWithOptions to retrieve flow details.

```csharp
// 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.Dingtalkesign_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkesign_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkesign_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkesign_2_0.Models.GetFlowDetailHeaders getFlowDetailHeaders = new AlibabaCloud.SDK.Dingtalkesign_2_0.Models.GetFlowDetailHeaders();
            getFlowDetailHeaders.XAcsDingtalkAccessToken = "<your access token>";
            try
            {
                client.GetFlowDetailWithOptions("PRO-E990Dxxx", getFlowDetailHeaders, 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 Request Example

Source: https://open.dingtalk.com/document/development/obtain-enterprise-authentication-information

This is an example of an HTTP GET request to retrieve enterprise authentication information. Ensure you include the Host and x-acs-dingtalk-access-token headers.

```HTTP
GET /v1.0/contact/organizations/authInfos?targetCorpId=dingxxxxxxx HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:xxxxxx
Content-Type:application/json
```
Tokens:
Raw