Sparkles EditorImagination, made real.Credits & billing
All guides
Chat channels

DingTalk AI bot setup: real screenshots for permissions, cards and publishing

This guide uses real DingTalk Open Platform screenshots instead of a demo video. It covers permissions, JSON card import, variables, preview states and publishing, then shows how to connect the published template to Sparkles.

Connect a DingTalk enterprise bot to Sparkles with real screenshots for Stream mode, permissions, JSON card import, variables, preview states and publishing.
View full-size image
Real DingTalk Open Platform screenshots for the setup flow; App Secrets, bot secrets, email and balance are excluded.

Use an enterprise app with Stream mode

Sparkles connects to a DingTalk enterprise internal application bot. Enable the bot and use Stream mode for message delivery; a custom group Webhook bot is not an equivalent. Messages, images and files still follow Sparkles sessions, model access and Credits rules.

DingTalk bot configuration page with Stream mode selected
Real screenshot: the bot is enabled and set to Stream mode.
DingTalk event subscription page with Stream push selected
Real screenshot: the event subscription page shows the Stream push entry point.

Verify the four required capabilities

In Permission Management, verify enterprise bot messaging, interactive card instance write, AI card instance write and AI card streaming update. The screenshot shows the card and bot capabilities as enabled. Unrelated todo or group permissions are not required for this flow. Permission changes take effect only after an application version is published.

DingTalk permission management page showing card and bot capabilities enabled
Real screenshot: AI card instance write, enterprise bot messaging, interactive card instance write and AI card streaming update all show Enabled.

Import the JSON into a fresh card draft

Create a new AI card draft, open the editor and choose More → Import card template. Select the Sparkles v1.1 JSON, confirm the replacement, then inspect the canvas and return to the template list. The template ID must belong to your enterprise; another enterprise’s published ID cannot be reused. Download the Sparkles v1.1 template.

DingTalk card builder More menu with Import card template
Real screenshot: the More menu exposes Import card template.
DingTalk card editor overview with the card structure and controls
Real screenshot: use the editor overview to check the card structure, buttons and styling after import.
DingTalk card builder canvas after importing the template
Real screenshot: inspect the card structure and buttons in the editor after import.
DingTalk card template list showing the Sparkles AI assistant template
Real screenshot: the list shows the published Sparkles AI assistant v1.1 compact template and its template ID.

Check the public variables

Keep content, status, openUrl, choiceCount, choiceId0–choiceId5 and choiceLabel0–choiceLabel5. Empty choice labels hide their buttons. Variables control presentation only; Sparkles keeps the user, task, session and permissions on the server.

DingTalk card builder variable panel listing content, status and choice variables
Real screenshot: the variable panel shows content, status, openUrl, choiceId and choiceLabel variables.

Preview every delivery state

Use Preview mode to inspect wrapping, Chinese labels, choice buttons and the full-workspace link. Check Processing, Output, Complete and Failed in turn. A completed card must not keep a spinner, and a failed card must not leave unusable choices. The builder preview is evidence about the template, not proof that a live bot has delivered it.

DingTalk card builder Preview mode showing the Sparkles AI assistant card
Real screenshot: Preview mode shows the body, three choice buttons and the View work and conversation link.
DingTalk card builder Processing state
Real screenshot: card preview in Processing state.
DingTalk card builder Output state
Real screenshot: card preview in Output state.
DingTalk card builder Complete state
Real screenshot: card preview in Complete state.
DingTalk card builder Failed state
Real screenshot: card preview in Failed state.

Publish both the card and the application

The card editor publishes the template ID. Version Management and Release publishes the application permissions and bot settings to enterprise members. The real version page shows versions 1.0.1 and 1.0.0 online. Copy your own template ID and enter it in Sparkles after publishing.

DingTalk version management and release page showing online versions
Real screenshot: versions 1.0.1 and 1.0.0 are online.

Return to Sparkles with four configuration fields

In the DingTalk channel settings, enter Client ID / AppKey, Client Secret / AppSecret, Robot Code and your card template ID. Submit secrets only through the dedicated form; the page clears them after submission. Pair the administrator in a private chat, send /status, then run a short text and attachment test. Groups remain disabled until you enable them explicitly.

Final acceptance checklist

Verify enabled permissions, card variables, all four previews, a published template ID, a published application version, /status, a short conversation, a button callback and one attachment. Start with mention-only and administrator-only access. If delivery is uncertain, inspect the existing task before submitting another paid request.

Sources and further reading

Open channel settings

Sign in to connect Telegram or Lark. Models and creative tasks use your existing account Credits and permissions.