DingTalk Integration Guide
This guide helps you configure a DeepWorks bot in DingTalk so you can use DingTalk to control DeepWorks on your computer and complete coding tasks from anywhere.
Prerequisites
Before you start, make sure you meet the following requirements:
- DeepWorks is installed on your computer and the IM Channels remote-control feature is enabled.
- You have a DingTalk account with enterprise administrator permissions.
If you do not have a DingTalk account, go to the DingTalk website , download the client, and create a team.
Create a DingTalk App
Sign In to the Developer Console
Open a browser, go to the DingTalk developer console , and sign in with an administrator account.

Select an organization you have joined. If the system shows This account has not joined an organization, you can create a personal enterprise and fill in the required information.

Create the App
- On the developer console home page, go to
DingTalk Developmentand clickCreate App.

- In the creation dialog, fill in the following information:
| Field | Value (can be changed later) | Description |
|---|---|---|
| App name | Any value | Custom name |
| App description | Any value | Brief description of the purpose |
| App type | Can be left unset for now |

- After completing the fields, click
Save.
Add Bot Capability
After the app is created, the Add App Capability page opens automatically:
- Find
Bot, then clickAdd Bot. - Fill in the basic bot information. Stream mode is recommended for the message receiving mode.
- Click
Confirm and Publish.

Configure App Permissions
To let the bot send and receive messages normally, enable the following permissions:
- In the left menu of the app details page, click
Permissions. - Search for each permission and click
Enable Now:- Enterprise employee mobile-phone information
- Member information read permission
- Permission to send messages as a bot within the enterprise
- Interactive card instance write permission
- AI card streaming update permission

Publish the App
After configuring the app, create and publish a version so the configuration takes effect. Before publishing, make sure the app availability range includes everyone who needs to use the bot.
Create a Version
In the left menu of the app details page, select Version Management and Release, then click Create New Version.

Fill In Version Information and Set Availability
- Fill in the
App VersionandVersion Description, briefly explaining this release. - Under
App Availability, selectAll Employees,Some Employees,Administrators Only, orOnly Meas needed. If access is limited to specific people, selectSome Employeesand add them. - Confirm that all intended users are included, then click
Save.

Confirm the Release
- After saving, click
Releaseon the version details page. - In the confirmation dialog, click
Confirm and Publish. - Return to
Version Management and Releaseand check that the version status isOnline.

Get App Credentials
View Credential Information
- In the left menu of the app details page, click
Credentials and Basic Information. - Find these two values:
- Client ID (also called AppKey)
- Client Secret (also called AppSecret)
Store the credentials securely and do not disclose them to others.
Configure DingTalk in DeepWorks
You can scan a QR code with your phone to create and connect a DingTalk app, or manually enter the credentials of an existing app.
Prerequisites: Both methods require DingTalk enterprise administrator permissions. Make sure the bot’s app has enabled every permission listed in chapter 3, Configure App Permissions. Scanning a QR code does not waive the administrator or app permission requirements.
Open Bot Configuration
- Click your user avatar in the lower-left corner of DeepWorks, select
IM Channels, and confirm the workspace to configure. - On the
Channel Connectionstab, connect your DingTalk account. See IM Channels. - Switch to the
Botstab, clickAdd Bot→DingTalk, and open theCreate DingTalk Botdialog.

Choose a Connection Method
Method 1: Scan a QR Code
- Click
One-Click Create DingTalk App by QR Code. - Use DingTalk on your phone to scan the QR code generated on the DeepWorks page, confirm creation with an account that has enterprise administrator permissions, and follow the prompts on your phone.
- When it finishes, the system fills in the app credentials automatically. Return to the creation dialog, check the credentials, and enter a
Bot Namethat matches the actual bot name. - In the DingTalk developer console, check the app permissions and make sure every permission listed in chapter 3 is enabled. Then complete the version release as described in chapter 4.

Method 2: Enter Credentials Manually
If you already created an app in the DingTalk developer console, enter the following information directly:
| Field | Instruction |
|---|---|
| Bot Name | Keep it consistent with the actual bot name in DingTalk. |
| Client ID | Enter the app’s Client ID (AppKey). |
| Client Secret | Enter the app’s Client Secret (AppSecret). |
For how to obtain app credentials, see Get App Credentials above. Before connecting, make sure app permissions are configured and a version has been published.
Create and Enable the Bot
- Confirm that the bot name and app credentials are complete, turn on
Enable Bot, and clickCreate. - Return to the
My Botslist and confirm that the bot has been added and is enabled. Later, useConfigureto change its information or theEnable Botswitch to change its status. - Open the bot conversation in DingTalk, send a message, and check whether you receive a reply.
After your DingTalk account is connected, you can also use a bot already connected by you or someone else without creating it again. If you do not have access, open the Enterprise Bots list, find its creator, and request access.
Start Using It
After connecting your DingTalk account and bot, send tasks and receive replies in a group chat or a direct chat. Before use, confirm that the bot is enabled, the app is published, all users are within the app availability range, and the computer remains on and running DeepWorks.
Use It in a Group Chat
Step 1: Add the bot to the group
- Open the DingTalk group that will use the bot, and confirm that the group belongs to the same organization as the bot.
- Click the settings icon in the upper-right corner of the group and find
BotsunderGroup Settings. - Open bot management and follow the prompts to add the bot connected to DeepWorks. If the bot is already in the group, you can start the conversation directly.

Step 2: @mention the bot to send a task
In the group input box, enter @, select the bot, enter your question or task, and send it. After DeepWorks processes the task, the bot returns the reply to the group. Continue to @mention the bot whenever you send another task.

Step 3: View the conversation in DeepWorks
To follow the task, return to DeepWorks, find the conversation marked with the DingTalk icon in the selected workspace, and open it to review the task, processing status, and reply.

Use It in a Direct Chat
A direct chat is suitable for personal tasks. You do not need to add the bot to a group or @mention it.
Step 1: Open the bot conversation
Enter the bot name in the DingTalk top search box, select the bot, and open the direct chat. If a conversation already exists, open it from the message list.
Step 2: Send a task and view the reply
Describe your question or task in the input box and send it. After DeepWorks processes the task, the reply is returned to the same conversation. To add requirements, continue sending messages in that conversation.

Step 3: Review task processing
To review the detailed process, return to DeepWorks, open the conversation marked with the DingTalk icon in the corresponding workspace, and check the task, processing status, reply process, and final result.

FAQ
If you receive one of the following messages when using the bot, resolve it as described and send another message to verify the result.
What should I do if the message says “Permissions are not configured, so you cannot interact with the bot”?

Ask an administrator to check the app availability range and make sure it includes your account. In the DingTalk developer console, the administrator can open the app’s Version Management and Release, adjust App Availability, save the change, and publish the version. For details, see chapter 4, Publish the App.
What should I do if the message says “Unable to read the channel mobile number, so an existing binding cannot be verified”?

Ask the bot administrator to check the app permissions and address-book access range:
- Follow chapter 3,
Configure App Permissions, and verify that all required permissions are enabled. Pay particular attention toEnterprise employee mobile-phone informationandMember information read permission. - Confirm that the address-book access range includes your account, so the app can read your mobile number and verify the binding.
- If a configuration change requires a release, publish the new version before sending another message to verify it.
What should I do if the message says “The current mobile number is not bound to a DeepWorks channel account”?

Connect your DingTalk account in DeepWorks:
- Click your user avatar in the lower-left corner, select
IM Channels, and confirm the workspace to use. - On the
Channel Connectionstab, clickConnecton the DingTalk card. - Enter the mobile number you actually use in DingTalk and complete the connection as prompted.
- After the card shows
Connected, return to DingTalk and send the message again.
If the account is already connected, check whether the bound mobile number matches the current DingTalk account. If it does not, unbind it and reconnect with the correct number.