Message notification types
Work notification messages
Notification messages pushed to employees in the name of a micro app in an organization’s Work Notifications chat. Examples include birthday greetings and onboarding reminders.Send work notifications by using a template
Description
- Message templates are supported only by third-party enterprise apps, not by internal apps.
- Only message templates that have passed review can be used to push work notification messages.
- Markdown template A Markdown template configures and sends messages by using Markdown syntax. It is suitable for pure notification messages that do not require any action. Markdown templates conveniently support text, images, links, and other display formats.
- ActionCard template An ActionCard template sends messages by using the ActionCard message type. It supports messages that combine content with action points, suitable for scenarios where a recipient needs to quickly process the message through one or multiple action points. Built on the Markdown template, the ActionCard template supports both overall jump and individual jump styles.
- Form template A Form template sends messages based on the OA message type. It is suitable for displaying messages such as orders, and supports jumping to view message details.
Integration flow
As shown in the following figure, sending work notifications by using a message template requires the following steps:- Create and configure a message template. For more information, see Manage message templates.
- Submit the template for review.
- Call the API to send work notifications by using a template. For more information, see Send work notification messages by using a template.
Open capability overview
Message notifications provide a rich set of open API capabilities. Developers can use the APIs to integrate message notifications with an organization’s business systems.| API | Description | Version |
|---|---|---|
| Send work notifications | Sends work notification messages. | Legacy |
| Update the status bar of work notifications | Updates the status of OA work notification messages. | Legacy |
| Get the sending progress of work notification messages | Gets the sending progress of work notification messages. | Legacy |
| Get the sending result of work notification messages | Queries the sending result of work notification messages. | Legacy |
| Recall work notification messages | Recalls work notification messages. | Legacy |
| Send work notification messages by using a template | Sends work notifications by using a message template. | Legacy |
How to integrate the message notification APIs
DingTalk provides examples of integration flows for the message notification APIs.- Click a work notification to redirect to a DingTalk mini program
- Click a work notification to redirect to a web app
- Send, query, and recall work notifications
Glossary
task_id
task_id is the unique identifier field for a work notification message. It is returned when you call the Send work notifications API.
You can use task_id to call the Get the sending progress of work notification messages API and the Get the sending result of work notification messages API to query the sending progress and result of a work notification message.