DingTalk Open Platform

https://open.dingtalk.com/document/development
Admin
DingTalk Open Platform provides developers with comprehensive APIs and tools to build mini-programs,...
Tokens:1,682,139
Snippets:10,651
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Go SDK

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

Use the go get command to install the DingTalk OpenAPI Go SDK.

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

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

### Install Golang SDK

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

Install the DingTalk Stream SDK for Golang version v0.0.5 using the go get command.

```go
go get github.com/open-dingtalk/dingtalk-stream-sdk-go/v0.0.5
```

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

### HTTP Request Example

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

This is an example of an HTTP GET request to retrieve the knowledge list. Ensure you replace placeholders with actual values.

```HTTP
GET /v1.0/assistant/knowledges/items?assistantId=123-456 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:f2a6d208b64432df8eea4a9a937c95cb
Content-Type:application/json
```

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

### HTTP Request Example

Source: https://open.dingtalk.com/document/development/obtain-the-file-list-storage

This is an example of the HTTP GET request to retrieve a list of files or folders. Ensure you replace placeholders with actual values.

```http
GET /v1.0/storage/spaces/{spaceId}/dentries?parentId=String&nextToken=String&maxResults=Integer&orderBy=String&order=String&withThumbnail=Boolean&unionId=String HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:String
Content-Type:application/json
```

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

### HTTP Request Example

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

Demonstrates the GET request to retrieve user attribute visibility settings, including pagination parameters.

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

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

### HTTP GET Request Example

Source: https://open.dingtalk.com/document/development/query-the-details-of-employees-who-have-left-office

This example demonstrates how to make a GET request to the employee leave records API. Ensure you replace '<your access token>' with a valid token.

```HTTP
GET /v1.0/contact/empLeaveRecords?startTime=2020-07-10T00:00:00Z&endTime=2020-08-10T00:00:00Z&nextToken=0&maxResults=10 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:afe814xxx
Content-Type:application/json
```

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

### Go: Initialize Client and List Directory Contents

Source: https://open.dingtalk.com/document/development/get-a-list-of-all-files-or-folders-under-a

This Go example shows how to create a DingTalk storage client and list all entries in a directory. It includes error handling and setting request options like pagination and thumbnail generation.

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

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


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

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

  listAllDentriesHeaders := &dingtalkstorage_1_0.ListAllDentriesHeaders{}
  listAllDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.ListAllDentriesRequestOption{
    NextToken: tea.String("3678056xxxxx"),
    MaxResults: tea.Int32(30),
    Order: tea.String("DESC"),
    WithThumbnail: tea.Bool(true),
  }
  listAllDentriesRequest := &dingtalkstorage_1_0.ListAllDentriesRequest{
    UnionId: tea.String("chyxxxxx"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListAllDentriesWithOptions(tea.String("897xxxxx"), listAllDentriesRequest, listAllDentriesHeaders, &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 Request Example

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

This is an example of an HTTP GET request to the Task Info API.

```HTTP
GET /v2.0/doc/task/info/12345678 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:example-token
Content-Type:application/json
```

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

### App.onLaunch Example

Source: https://open.dingtalk.com/document/development/obtains-the-startup-parameters-of-mini-programs

This snippet shows how to access launch options within the App.onLaunch method in JavaScript.

```javascript
App({
  onLaunch(options) {
    console.log(options);
    }
})
```

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

### HTTP GET Request for Get Ask Detail

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

Example of an HTTP GET request to the Get Ask Detail API. Includes parameters for assistant ID, pagination, and time range.

```HTTP
GET /v1.0/assistant/askDetails?assistantId=02125927e37b4a8f86da0e57125038&offset=0&pageSize=3&startTime=0&endTime=1722505491000 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:f2a6d208b64432df8eea4a9a937c95cb
Content-Type:application/json
```

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

### C#: Initialize Client and List Directory Contents

Source: https://open.dingtalk.com/document/development/get-a-list-of-all-files-or-folders-under-a

This C# example shows the setup for initializing the DingTalk storage client. It includes the necessary using statements and a basic structure for the client creation method.

```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.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();

```

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

### Install C# SDK

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

Use the dotnet CLI to add the AlibabaCloud Dingtalk package.

```javascript
dotnet add package AlibabaCloud.SDK.Dingtalk
```

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

### Event Chain Configuration Example

Source: https://open.dingtalk.com/document/development/chain-of-events

This example demonstrates how to configure an event chain, including adding a 'Return Request' event and setting up success and failure callbacks for a popup notification.

```json
{
  "cardData": {
    "cardParamMap": {
      "result": "https://open-dev.dingtalk.com/fe/card"
    }
  },
  "userPrivateData": {
    "cardParamMap": {}
  },
  "cardUpdateOptions": {
    "updateCardDataByKey": true,
    "updatePrivateDataByKey": true
  }
}
```

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

### Get Permission List Response Example

Source: https://open.dingtalk.com/document/development/get-permission-list

Example of a successful JSON response containing permission details and pagination tokens.

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

{
  "permissions" : [ {
    "dentryUuid" : "EpGBxxxxgN7R35y",
    "member" : {
      "type" : "USER",
      "id" : "01472xxxx041",
      "corpId" : "ding16b241fd05********288",
      "name" : "member_name"
    },
    "role" : {
      "id" : "MANAGER",
      "name" : "MANAGER"
    },
    "duration" : 3600
  } ],
  "nextToken" : "next_token"
}
```

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

### PHP: Initialize Client and List Directory Contents

Source: https://open.dingtalk.com/document/development/get-a-list-of-all-files-or-folders-under-a

This snippet demonstrates how to initialize the SDK client and list all entries within a directory using PHP. It includes the necessary autoloader and sample main function.

```php
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```
```

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

### Asynchronous Card Creation Setup

Source: https://open.dingtalk.com/document/development/interface-for-creating-a-card-instance

Initializes the client and sets up headers for an asynchronous card creation request.

```python
@staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_card_headers = dingtalkcard__1__0_models.CreateCardHeaders()
        create_card_headers.x_acs_dingtalk_access_token = '<your access token>'
        top_open_space_model = dingtalkcard__1__0_models.CreateCardRequestTopOpenSpaceModel(
            space_type='ONE_BOX'
        )
```

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

### HTTP Request Example

Source: https://open.dingtalk.com/document/development/obtain-the-ssotoken-for-micro-application-background-logon-free

This is an example of an HTTP GET request to obtain the SSOToken. Ensure you replace 'ding1234' and '12345' with your actual corpid and corpsecret.

```http
GET https://oapi.dingtalk.com/sso/gettoken?corpid=ding1234&corpsecret=12345
```

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

### Launch Options Return Object Example

Source: https://open.dingtalk.com/document/development/jsapi-get-launch-options-sync

An example of the object returned by dd.getLaunchOptionsSync, illustrating the structure of 'path', 'query', and 'scene' properties.

```javascript
{ "path": `path示例值`, "query": { "param1": "sss" }, "scene": "create" }
```

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

### Python SDK Example for Copying Document

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

This Python snippet is a placeholder for the SDK example. It indicates the start of the Python code for copying documents.

```python
# -*- coding: utf-8 -*

```

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

### Initialize Client and Headers in PHP

Source: https://open.dingtalk.com/document/development/create-and-deliver-cards

Sets up the DingTalk client with configuration and prepares the headers for the request.

```php
<?php

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

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

use Darabonba\\OpenApi\\Models\\Config;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverHeaders;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\docOpenDeliverModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\coFeedOpenDeliverModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\topOpenDeliverModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imRobotOpenDeliverModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imGroupOpenDeliverModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imSingleOpenDeliverModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\topOpenSpaceModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\coFeedOpenSpaceModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imRobotOpenSpaceModel\\notification;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imRobotOpenSpaceModel\\searchSupport;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imRobotOpenSpaceModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imGroupOpenSpaceModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\imSingleOpenSpaceModel;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\openDynamicDataConfig\\dynamicDataSourceConfigs\\pullConfig;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\openDynamicDataConfig\\dynamicDataSourceConfigs;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\openDynamicDataConfig;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\PrivateDataValue;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest\\cardData;
use AlibabaCloud\\SDK\\Dingtalk\\Vcard_1_0\\Models\\CreateAndDeliverRequest;
use AlibabaCloud\\Tea\\Utils\\Utils\\RuntimeOptions;

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();
        $createAndDeliverHeaders = new CreateAndDeliverHeaders([]);
        $createAndDeliverHeaders->xAcsDingtalkAccessToken = "<your access token>";
```

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

### HTTP Request Example for JSAPI Ticket

Source: https://open.dingtalk.com/document/development/obtain-jsapi-ticket

This is an example of an HTTP GET request to obtain a JSAPI ticket. Replace `ACCESS_TOKEN` with a valid access token.

```http
GET https://oapi.dingtalk.com/get_jsapi_ticket?access_token=ACCESS_TOKEN
```

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

### Initialize and Fetch Storage Info in Go

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

Uses the DingTalk Go SDK to initialize a client and call the GetOrgWithOptions method.

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

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


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

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

  getOrgHeaders := &dingtalkstorage_1_0.GetOrgHeaders{}
  getOrgHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getOrgRequest := &dingtalkstorage_1_0.GetOrgRequest{
    UnionId: tea.String("cHtUYxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetOrgWithOptions(tea.String("ding123xxxxx"), getOrgRequest, getOrgHeaders, &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)
  }
}
```

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

### Create Card Instance in Python

Source: https://open.dingtalk.com/document/development/interface-for-creating-a-card-instance

Shows client initialization and the configuration of various space models for card creation.

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

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_card_headers = dingtalkcard__1__0_models.CreateCardHeaders()
        create_card_headers.x_acs_dingtalk_access_token = '<your access token>'
        top_open_space_model = dingtalkcard__1__0_models.CreateCardRequestTopOpenSpaceModel(
            space_type='ONE_BOX'
        )
        co_feed_open_space_model = dingtalkcard__1__0_models.CreateCardRequestCoFeedOpenSpaceModel(
            title='xxxx卡片'
        )
        im_robot_open_space_model_notification = dingtalkcard__1__0_models.CreateCardRequestImRobotOpenSpaceModelNotification(
            alert_content='你收到了1条卡片消息',
            notification_off=False
        )
        im_robot_open_space_model_search_support = dingtalkcard__1__0_models.CreateCardRequestImRobotOpenSpaceModelSearchSupport(
            search_icon='@lALPDgQ9q8hFhlHNAXzNAqI',
            search_type_name='{"ZH_CN":"待办","ZH_TW":"待辦","EN_US":"ToDo"}',
            search_desc='卡片的具体描述'
        )
        im_robot_open_space_model_last_message_i18n = {
            'key': '互动卡片消息'
        }
        im_robot_open_space_model = dingtalkcard__1__0_models.CreateCardRequestImRobotOpenSpaceModel(
            support_forward=False,
            last_message_i18n=im_robot_open_space_model_last_message_i18n,
            search_support=im_robot_open_space_model_search_support,
            notification=im_robot_open_space_model_notification
        )
        im_group_open_space_model_notification = dingtalkcard__1__0_models.CreateCardRequestImGroupOpenSpaceModelNotification(
            alert_content='你收到了1条卡片消息',
            notification_off=False
        )
```

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

### Get Task Info API Success Response

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

Example of a successful response from the Get Task Info API, indicating a task with partial success.

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

{
  "taskId" : "abcd",
  "status" : 2,
  "totalCount" : 1,
  "succCount" : 1,
  "failCount" : 0
}
```

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

### Get Access Token (Node.js)

Source: https://open.dingtalk.com/document/development/obtain-orgapp-token

Node.js example demonstrating how to get an access token. This code uses a client library and requires async/await for handling promises.

```javascript
let { Config, OapiGettokenParams, OapiGettokenRequest } = require('./client.js');
let Client = require('./client.js').default
async function test() {
  const config = new Config()
  config.serverUrl = 'https://oapi.dingtalk.com/gettoken'
  config.session = 'access_token'
  const params = new OapiGettokenParams();
  params.appKey = 'bab02f63c1e030fbbxxxx'
  params.appSecret = 'bab02f63c1e030fbbxxxx'
  const request = new OapiGettokenRequest()
  request.params = params
  const client = new Client(config)
  try {
    const res = await client.oapiGettoken(request)
    console.log(res.body)
  } catch (err) {
    console.log(err)
  }
}
test()
```

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

### Request Example (JAVA SDK)

Source: https://open.dingtalk.com/document/development/obtain-isvapp-token

This Java SDK example demonstrates how to request an access token for a corp. Ensure you have the correct accessKey, accessSecret, and suiteTicket.

```java
DefaultDingTalkClient client= new DefaultDingTalkClient("https://oapi.dingtalk.com/service/get_corp_token");
OapiServiceGetCorpTokenRequest req= new OapiServiceGetCorpTokenRequest();
req.setAuthCorpid("dingc365fcxxxx");
OapiServiceGetCorpTokenResponse execute= client.execute(req,"accessKey","accessSecret","suiteTicket");
```

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

### HTTP Request to Get Senior Settings

Source: https://open.dingtalk.com/document/development/get-user-executive-mode-settings

This is an example of an HTTP GET request to retrieve senior settings for a user. Ensure you replace placeholders with actual values.

```HTTP
GET /v1.0/contact/seniorSettings?seniorStaffId=1234567 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:afe8143b8xxx
Content-Type:application/json
```

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

### Example of Mini-Program Link with Parameters

Source: https://open.dingtalk.com/document/development/message-link-description

An example demonstrating how to pass parameters to a mini-program page via a message link. Parameters must be URL-encoded if they contain special characters.

```url
eapp://pages/index/index?param1=aa&param2=bb
```

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

### Get File Info

Source: https://open.dingtalk.com/document/development/jsapi-file-system-manager-get-file-info

Call FileSystemManager.getFileInfo to get information about a local file. This example shows how to retrieve file size and digest. Ensure the filePath is correctly specified.

```javascript
const fileSystemManager = dd.FileSystemManager();

fileSystemManager.getFileInfo({
  filePath: '`${dd.env.USER_DATA_PATH}/test.txt`',
  digestAlgorithm: '***',
  success: (res) => {
    const { size, digest } = res;
  },
  fail: () => {},
  complete: () => {},
});
```

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

### Initialize Client and Query Public Devices (PHP)

Source: https://open.dingtalk.com/document/development/query-public-equipment

This snippet shows how to initialize the client and make a request to the GetPublicDevices API in PHP. Ensure you have the vendor autoload.php file included.

```php
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

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

### dd.getLaunchOptionsSync

Source: https://open.dingtalk.com/document/development/jsapi-get-launch-options-sync

Retrieves the parameters that were present when the mini-program was launched. This includes the path, any query parameters, and the launch scene.

```APIDOC
## dd.getLaunchOptionsSync

### Description
Retrieves the parameters that were present when the mini-program was launched. This includes the path, any query parameters, and the launch scene.

### Method
Sync

### Endpoint
N/A (Client-side API)

### Parameters
This method inherits parameters from the [General Input Object](https://open.dingtalk.com/document/direction/jsapi-standard-input-output-object). Extended properties are empty.

### Response
Inherits from the [General Output Object](https://open.dingtalk.com/document/direction/jsapi-standard-input-output-object). Extended properties describe:
- **path** (string) - The path of the mini-program.
- **query** (object) - The query parameters of the mini-program.
- **scene** (string) - The scene in which the mini-program was launched.

#### Success Response (200)
- **path** (string) - Description of the path.
- **query** (object) - Description of the query parameters.
- **scene** (string) - Description of the launch scene.

#### Response Example
```json
{
  "path": "path示例值",
  "query": {
    "param1": "sss"
  },
  "scene": "create"
}
```
```

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

### HTTP GET Request for Public Devices

Source: https://open.dingtalk.com/document/development/query-public-equipment

This snippet shows an example of an HTTP GET request to query public devices. It includes common query parameters for filtering and pagination.

```HTTP
GET /v1.0/exclusive/trusts/publicDevices?platform=Mac&startTime=1671767361000&endTime=1671767361000&pageSize=100&pageNumber=1&title=这是标题&macAddress=88:66:5a:07:2b:04&serialNumber=11-22-33-44&deviceUuid=123 HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:e29ed86dfc0a3cf0b32c9f4*****16
Content-Type:application/json
```

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

### Get User Details using C#

Source: https://open.dingtalk.com/document/development/queries-the-details-of-a-dedicated-account

This C# example demonstrates how to call the DingTalk API to get user details using the provided SDK. Replace 'access_token' with your actual token.

```csharp
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/user/get");
OapiV2UserGetRequest req = new OapiV2UserGetRequest();
req.Userid = "zhangsan";
req.Language = "zh_CN";
req.LoginId = "zhangsan";
OapiV2UserGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

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

### Go: Initialize DingTalk Client

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

Demonstrates how to initialize a DingTalk client in Go using configuration for protocol and region ID.

```go
package main

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


// Description:
// 
// 使用 Token 初始化账号Client
// 
// @return Client
// 
// @throws Exception

```

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

### Get Branch Organization List (Java)

Source: https://open.dingtalk.com/document/development/obtains-the-branch-organization-list

Java code example for calling the DingTalk API to get branch organization lists. This requires the DingTalk SDK and a valid access token.

```Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/org/union/branch/get");
OapiOrgUnionBranchGetRequest req = new OapiOrgUnionBranchGetRequest();
OapiOrgUnionBranchGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
```

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

### Install Node.js SDK

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

Use npm to install the DingTalk SDK for Node.js.

```javascript
npm install @alicloud/dingtalk --save
```

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

### SyncHTTP/RDS Push biz_data Example (biz_type=201)

Source: https://open.dingtalk.com/document/development/single-chat-install-cool-app

This is an example of the biz_data payload for SyncHTTP/RDS push, specifically for biz_type 201, when a cool app is installed in a single chat. This data is inserted into the open_sync_biz_data_medium table.

```javascript
{
  "corp_id": "ding9f50b15bxxxx16741",
  "biz_id": "1663**35567",
  "biz_type": 201,
  "biz_data": {
    "eventId": "c7c7120f2c07419**ebdba0318c8",
    "singleChatOtherUserId": "234567",
    "syncAction": "single_conversation_cool_app_install",
    "coolAppCode": "COOLAPP-1-1018xxxxxxxxxxxxxxxx",
    "operateTime": "1641866135051",
    "openConversationCorpId": "ding9bd1bfb59xxxxxxxxxxxxxxxxxxx",
    "robotCode": "rBLBXuiaA2rn3xxxxxxxxxxxxxx",
    "openConversationId": "cidT461wC7yvGJxxxxxxxxxxxxxx",
    "operator": "123455"
  }
}
```

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

### Node.js: Initialize Client and List Directory Contents

Source: https://open.dingtalk.com/document/development/get-a-list-of-all-files-or-folders-under-a

This Node.js example demonstrates initializing the DingTalk storage client and listing directory contents. It uses async/await for handling API calls and includes error handling for API responses.

```javascript
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';


export default class Client {

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

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let listAllDentriesHeaders = new $dingtalkstorage_1_0.ListAllDentriesHeaders({ });
    listAllDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let option = new $dingtalkstorage_1_0.ListAllDentriesRequestOption({
      nextToken: "3678056xxxxx",
      maxResults: 30,
      order: "DESC",
      withThumbnail: true,
    });
    let listAllDentriesRequest = new $dingtalkstorage_1_0.ListAllDentriesRequest({
      unionId: "chyxxxxx",
      option: option,
    });
    try {
      await client.listAllDentriesWithOptions("897xxxxx", listAllDentriesRequest, listAllDentriesHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

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

```

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

### Create and Deliver Card Instance (Go)

Source: https://open.dingtalk.com/document/development/example-of-calling-the-card-api-interface

This snippet demonstrates how to create and deliver a card instance using Go. It includes defining helper functions, setting up the request details, and making a POST request to the API.

```APIDOC
## POST https://api.dingtalk.com/v1.0/card/instances/createAndDeliver

### Description
Creates and delivers a card instance to a specified open space using Go.

### Method
POST

### Endpoint
https://api.dingtalk.com/v1.0/card/instances/createAndDeliver

### Parameters
#### Request Body
- **cardTemplateId** (string) - Required - The ID of the card template.
- **outTrackId** (string) - Required - A unique identifier for tracking the request.
- **cardData** (object) - Required - The data to be populated into the card template.
  - **cardParamMap** (object) - Required - A map of parameters for the card template. Values will be converted to strings.
- **openSpaceId** (string) - Required - The ID of the open space where the card will be delivered.
- **topOpenSpaceModel** (object) - Optional - Model for the top open space.
  - **spaceType** (string) - Required - The type of the space (e.g., "ONE_BOX").
- **topOpenDeliverModel** (object) - Optional - Model for delivering the card.
  - **expiredTimeMillis** (integer) - Required - The expiration time of the card in milliseconds since epoch.

### Request Example
```json
{
    "cardTemplateId": "{卡片模板 id}",
    "outTrackId": "{uuid}",
    "cardData": {
        "cardParamMap": {
            "string": "字符串",
            "boolean": "true",
            "number": "1",
            "markdown": "# markdown",
            "obj": "{\"key\": \"value\"}",
            "arr": "[{\"key\": \"value\"}]"
        }
    },
    "openSpaceId": "dtv1.card//ONE_BOX.{群聊 openConversationId}",
    "topOpenSpaceModel": {
        "spaceType": "ONE_BOX"
    },
    "topOpenDeliverModel": {
        "expiredTimeMillis": 1739795765042
    }
}
```

### Response
#### Success Response (200)
- **response** (object) - The response from the API, typically containing details of the delivered card instance.
```

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

### HTTP Push Event Body Example

Source: https://open.dingtalk.com/document/development/single-chat-install-cool-app

This is an example of the event body for HTTP push when a cool app is installed in a single chat. It contains similar information to the Stream mode but with a different structure.

```javascript
{
  "EventType": "single_conversation_cool_app_install",
  "EventTime": 1663143335567,
  "CorpId": "ding9f50b15bxxxx16741",
  "BizId": "1663**35567",
  "eventId": "c7c7120f2c07419**ebdba0318c8",
  "singleChatOtherUserId": "234567",
  "coolAppCode": "COOLAPP-1-1018xxxxxxxxxxxxxxxx",
  "operateTime": "1641866135051",
  "openConversationCorpId": "ding9bd1bfb59xxxxxxxxxxxxxxxxxxx",
  "robotCode": "rBLBXuiaA2rn3xxxxxxxxxxxxxx",
  "openConversationId": "cidT461wC7yvGJxxxxxxxxxxxxxx",
  "operator": "123455"
}
```

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

### Horizontal Alignment Configuration Examples

Source: https://open.dingtalk.com/document/development/update-cell-properties

Examples showing how to map horizontal alignment values to a grid range.

```json
{ "horizontalAlignments": [ ["left", "general"], ["center", "general"], ["right", "general"] ] }
```

```json
{ "horizontalAlignments": [ ["left", "left", "general"], ["center", "center", "general"], ["right", "right", "general"] ] }
```

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

### Stream Mode Push Event Body Example

Source: https://open.dingtalk.com/document/development/single-chat-install-cool-app

This is an example of the event body for Stream mode push when a cool app is installed in a single chat. It includes details about the event, the app, and the conversation.

```javascript
{
  "eventUnifiedAppId": "bbb381b6-f01xxxxx58daac",
  "eventCorpId": "ding9f50b15bxxxx16741",
  "eventType": "single_conversation_cool_app_install",
  "eventId": "c7c7120f2c07419**ebdba0318c8",
  "eventBornTime": 1683533823336,
  "data": {
    "singleChatOtherUserId": "234567",
    "coolAppCode": "COOLAPP-1-1018xxxxxxxxxxxxxxxx",
    "operateTime": "1641866135051",
    "openConversationCorpId": "ding9bd1bfb59xxxxxxxxxxxxxxxxxxx",
    "robotCode": "rBLBXuiaA2rn3xxxxxxxxxxxxxx",
    "openConversationId": "cidT461wC7yvGJxxxxxxxxxxxxxx",
    "operator": "123455"
  }
}
```
Tokens:
Raw