Server-Side Open APIs

In addition to open APIs for client-side calls, the YiDA platform also provides open APIs that support server-side calls. For details, see the DingTalk Open Platform documentation.

User Guide

Follow the steps below to use the YiDA server-side open APIs:

The DingTalk Open Platform offers multiple app types, and the way you use server-side open APIs varies by app type. For details, see Introduction to DingTalk App Types.

Step 1: Create a DingTalk App

To create an internal app, see Internal App Development Process Overview.
To create a third-party enterprise app, see Third-Party Enterprise App Overview.

Step 2: Add API Call Permissions

After the app is created, only sign-in and message notification APIs are enabled by default. Add the required API permissions based on your development needs.

For internal apps, see Add API Call Permissions.
For third-party enterprise apps, see Add API Call Permissions.

Step 3: Obtain the access_token for the App

The access_token serves as an identity credential. When calling an API, use the access_token to authenticate the caller’s identity.

For internal apps, see Obtain the access_token of an Internal App.
For third-party enterprise apps, see Obtain the access_token of the Authorized Enterprise.

API List

Workflow

API Description	Internal app	Third-party enterprise app	Third-party personal app	Permissions
Start a YiDA approval process	Supported	Supported	Not supported	YiDA workflow data write permission
Delete a workflow instance	Supported	Supported	Not supported	YiDA workflow data write permission
Terminate a workflow instance	Supported	Supported	Not supported	YiDA workflow data write permission

Form

API Description	Internal app	Third-party enterprise app	Third-party personal app	Permissions
Query form instance data	Supported	Supported	Not supported	YiDA form data read permission
Save form data	Supported	Supported	Not supported	YiDA form data write permission
Update form data	Supported	Supported	Not supported	YiDA form data write permission
Query form data	Supported	Supported	Not supported	YiDA form data read permission
Get the value of an employee component	Supported	Supported	Not supported	YiDA form data read permission
Get the form component definition list	Supported	Supported	Not supported	YiDA form data read permission
Get subform component data	Supported	Supported	Not supported	YiDA form data read permission
Delete form data	Supported	Supported	Not supported	YiDA form data write permission
Get multiple form instance IDs	Supported	Supported	Not supported	YiDA form data read permission
Get form instance data in batch	Supported	Supported	Not supported	YiDA form data read permission
Delete form instances in batch	Supported	Supported	Not supported	YiDA form data read permission
Create form instances in batch	Supported	Supported	Not supported	YiDA form data read permission
Update component values within form instances in batch	Supported	Supported	Not supported	YiDA form data read permission
Create or update a form instance	Supported	Supported	Not supported	YiDA form data read permission
Get form instance data by advanced query conditions (including subform component data)	Supported	Supported	Not supported	YiDA form data read permission
Get form instance data by advanced query conditions (excluding subform component data)	Supported	Supported	Not supported	YiDA form data write permission
Update form instances in batch using form instance data	Supported	Supported	Not supported	YiDA form data write permission
Query form change records	Supported	Supported	Not supported	YiDA form data write permission
Get the workflow design structure	Supported	Supported	Not supported	YiDA form data write permission
Get the component alias list	Supported	Supported	Not supported	YiDA form data write permission

Task

API Description	Internal app	Third-party enterprise app	Third-party personal app	Permissions
Get approval records	Supported	Supported	Not supported	YiDA workflow data read permission
Accept or decline a YiDA approval task	Supported	Supported	Not supported	YiDA workflow data write permission
Get tasks submitted by a user within the organization	Supported	Supported	Not supported	YiDA workflow data read permission
Get completed approval tasks in the organization	Supported	Supported	Not supported	YiDA task read permission
Transfer a task	Supported	Supported	Not supported	YiDA task write permission
Query running workflow tasks (VPC)	Supported	Supported	Not supported	YiDA task read permission
Get the task list (organization scope)	Supported	Supported	Not supported	YiDA task read permission
Get notifications sent to a user	Supported	Supported	Not supported	YiDA task read permission
Query the task list of items CC’d to me (app scope)	Supported	Supported	Not supported	YiDA task read permission
Submit a comment	Supported	Supported	Not supported	YiDA comment write permission
Execute YiDA approval tasks in batch	Supported	Supported	Not supported	YiDA comment write permission
Query comments on YiDA form instances in batch	Supported	Supported	Not supported	YiDA comment write permission

Attachment

API Description	Internal app	Third-party enterprise app	Third-party personal app	Permissions
Get the temporary silent login URL of a YiDA attachment	Supported	Supported	Not supported	YiDA workflow data read permission

Getting Started

Developer Guide

API

Tutorials

Components

User Guide

Step 1: Create a DingTalk App

Step 2: Add API Call Permissions

Step 3: Obtain the access_token for the App

API List

Workflow

Form

Task

Attachment

​User Guide

​Step 1: Create a DingTalk App

​Step 2: Add API Call Permissions

​Step 3: Obtain the access_token for the App

​API List

​Workflow

​Form

​Task

​Attachment

User Guide

Step 1: Create a DingTalk App

Step 2: Add API Call Permissions

Step 3: Obtain the access_token for the App

API List

Workflow

Form

Task

Attachment