This topic introduces conversation management.
What is conversation management
Conversation management is a set of capabilities through which DingTalk lets you create, configure, and manage groups and their members in flexible ways based on business needs. It also provides in-group services tailored to specific business scenarios, combining communication and collaboration. Organization members can collaborate and communicate efficiently, in a structured and clear manner, by leveraging rich group capabilities in Group Chats, improving collaborative office efficiency.
Version description
| Feature | Group management | Scenario-based group |
|---|
| Basic management of Group Chats and members | ✅ | ✅ |
| Preconfigure advanced features in Group Chats (such as pinned cards, group quick entries, and Group bots) | ❌ | ✅ |
| Batch manage Group Chats via APIs based on group templates | ❌ | ✅ |
| Customize group types and features within an organization based on group templates | ❌ | ✅ |
Open capability overview
Open API list
Conversation management provides a rich set of open APIs. Developers can integrate groups with enterprise business systems through these APIs.
Group management
| API | Description | API version |
|---|
| Create a Group Chat | Create an Internal Group or a Standard Group Chat. | New |
| Update a Group Chat | Update the basic information and members of a specified Group Chat by chatid. | New |
| Query group information | Retrieve the Group settings and member information. | Legacy |
| Update a member’s group nickname | Update a member’s nickname within a group. | Legacy |
| Set organization Group admins in batches | Grant or revoke admin permissions for organization Group members in batches. | New |
| Turn off Private Chat | Configure whether Group members can add each other as Contacts and have direct messages. | Legacy |
| Get the Group QR Code invitation link | Retrieve the QR Code invitation link for joining a group. | Legacy |
| Get the OpenConversationId of a Group Chat | Query the OpenConversationId by chatId. | New |
Group management
| API | Description | API version |
|---|
| Create a scenario-based group | Create a group based on a group template ID. | New |
| Update a scenario-based group | Update group information by group ID. | New |
| Add Group members | Add new members to a group (up to 1,000 members per group). | New |
| Remove Group members | Remove Group members by group ID and member ID. | New |
| Query group information | Retrieve the group name, group icon, Group owner ID, join link, and Group settings by group ID. | Legacy |
| Set the mute status of Group members | Set the mute status of members in a scenario-based group. | New |
| Query group mute status | Query the mute status of a group and its members. | New |
| Update a member’s group nickname | Update a member’s group nickname by group ID and member ID. | New |
| Update Group admins | Update the Group admins of a group. | New |
| Query brief group information | Retrieve basic information such as the group name, group icon, and Group owner ID by group ID. | New |
| Query Group members | Query Group member information. | New |
| Delete a Group Chat | Delete a specified group by group ID. | New |
| Query the group template bots in a group | Query information about the group template bots in a group. | New |
Group templates
| API | Description | API version |
|---|
| Enable a group template | Enable a group template by group template ID. | Legacy |
| Disable a group template | Disable a group template by group template ID. | Legacy |
Pinned card
| API | Description | API version |
|---|
| Create and enable a pinned interactive card | Create and enable a pinned interactive card in a conversation. | New |
| Close a pinned interactive card | Close a pinned interactive card in a conversation. | New |
Group assistant
| API | Description | API version |
|---|
| Send a group assistant message | Send a message to a group through the bot defined in the group template. | Legacy |
Callback event list
Conversation management supports callback events such as deleting a Group Chat, adding members, removing members, and changing the Group owner. For more events, see the event subscription overview.
Tutorials
DingTalk provides examples of the Integration flow for conversation management APIs.
Glossary
Chat
DingTalk supports two main conversation types: one-to-one Direct Message Chats and Group Chats.
Group members
All members that make up a Group Chat.
Group management roles
The roles in a Group Chat that hold different group management permissions, including Group owner, Group admin, and standard Group member. Their permission scope ranks as follows: Group owner > Group admin > standard Group member.
Group role
A role assigned to a Group member by the Group owner or a Group admin, such as “Product Manager” or “HR”.
Group template
By presetting a group template and using it to create a Group Chat, or by converting a standard Internal Group into a group that applies the template, you can install a variety of capabilities into the group at once, including Group settings, in-group bots, and in-group quick entries. You can also batch manage Group Chats through group templates. Group templates also support visibility scope settings and can be displayed in the group creation entry under the ”+” icon, allowing users in the organization to create Custom Group Chats with a single click directly from the DingTalk client.
Pinned card
Group Chats support inserting specified content into a group’s pinned area via API to display notifications, announcements, and other information, improving message reach.
Quick entry
Formerly known as group plugins. Open frequently used apps quickly from the in-group quick entry bar without redirecting to the workbench or app marketplace, enabling efficient business workflows within the group.
Group Chats support customizing quick entries for a specified group through group templates and Cool Apps, including the entry link and order. The quick entries in Single-chat bot conversations can also be configured at the organization level through APIs.
For instructions on creating a quick entry, see Create a quick entry (group plugin).
chatId
A chatId uniquely identifies a Group Chat. It is returned by the group creation API.
In future versions, chatid will no longer be used. Use openConversationId as the unique identifier for a Group Chat.
openConversationId
An openConversationId uniquely identifies a Group Chat. It is returned by the group creation API.