OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase AI DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog ServiceOceanBase DataPilotOceanBase OAgent

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase AI DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog ServiceOceanBase DataPilotOceanBase OAgent
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase OAgent

V2.2.0
  • Product overview
    • What is OAgent?
    • Key features
    • System architecture
    • Use cases
  • Quick start
  • Deployment
  • Overview
  • Sessions and diagnosis
    • Manage sessions
    • Switch dialogue models
    • Use @ to mention the analysis target
    • View the tool invocation process
    • Upload an attachment
    • Data visualization
    • FAQ
    • Export a report
  • Tools
  • Skill Management
  • Channel management
  • Knowledge base
    • Built-in knowledge base
    • Custom knowledge base
  • Scheduled tasks
    • Overview of scheduled tasks
    • Create a scheduled task
  • View usage
  • Model configuration
    • Manage model services
    • Model scoring
  • Settings and security
    • Product management
    • Experimental features
  • Best practices
    • Perform a cluster health inspection
    • Query cluster and topology information
    • Query resource metrics and task status
    • Read-only queries
    • Alert query and troubleshooting guide
    • Root cause analysis of exceptions
    • ASH diagnostic report
    • Analyze slow SQL, TopSQL, and abnormal SQL
    • SQL pre-analysis and tuning recommendations
    • Interpret execution plans
    • Diagnostic information statistics
    • Parameter check and change governance
    • Database change ticket
  • Appendix
    • Feature list
    • Built-in Skills
  • Release notes
    • OAgent V2.2.0 Release note
    • OAgent V2.1.0 Release note
    • OAgent V2.0.0 Release note
    • OAgent V1.8.0 Release note

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase OAgent
  3. V2.2.0

Channel management

Last Updated:2026-11-20 07:25:11

Supported access channels
When to use
Prerequisites
Procedure
Usage
What to do next

In addition to the web interface, OAgent supports integration with messaging apps such as DingTalk, Lark, WeCom, and Telegram, facilitating collaboration with existing enterprise duty groups and automation workflows. The same private chat session can be continued across different IM channels; group/room sessions are isolated by channel.

Supported access channels

Channel
Access Method
Typical uses
Web Dialog Browser Access to OAgent Frontend Main entry for routine inspection, diagnostics, and tuning
DingTalk Create a DingTalk chatbot and configure the callback Alert linkage in the duty group and on-demand diagnostic initiation
Feishu Create a Lark chatbot and configure the callback Team Collaboration and Report Push
WeCom Create an WeCom chatbot and configure the callback Internal Q&A Group, Scheduled Task Result Push
Telegram Create a Telegram Bot and configure its Token Cross-region teams, mobile troubleshooting

When to use

  • After an alert is received in a duty group, @OAgent in the group to directly initiate root cause analysis without switching to the web.
  • After a scheduled task generates a report, automatically push it to a specified IM group.
  • Quickly check cluster status via Telegram on mobile devices.

Prerequisites

  • OAgent has been correctly deployed and is accessible over the network by the target IM platform.
  • You have the permission to create a bot or application on the target IM platform.

Procedure

  1. In the left navigation bar, click Channels to go to the Channels page.

  2. The page displays four fixed channel cards (DingTalk, Lark, WeCom, Telegram). Click Set Up Now on the target card and enter the access parameters for the selected channel.

  3. Enter the access parameters for the selected channel:

    DingTalk
    Lark
    WeCom
    Telegram

    Enter the following parameters:

    • Client ID (DingTalk AppKey): Obtained from the "Credentials and Basic Information" page after creating an enterprise internal application on the DingTalk Open Platform.
    • Client Secret (DingTalk AppSecret): Obtained from the same page as Client ID. Keep it secure; if leaked, reset it on the Open Platform.

    Enter the following parameters:

    • App ID: Obtained from the "Credentials and Basic Information" page after creating an enterprise self-built application on the Lark Open Platform.
    • App Secret: Obtained from the same page as App ID. Keep it secure; if leaked, reset it on the Open Platform.

    Enter the following parameters:

    • Bot ID: Obtained from the application details page after navigating to "Application Management → Self-Built → Create Application" in the WeCom Admin console.
    • Secret: Obtained on the same page as the bot ID. Keep it secure. If it is leaked, reset it in the management console.

    Enter the following parameters:

    • Bot Token: Obtained after creating the bot with @BotFather.
  4. Click OK.

Usage

  • Trigger a session in the IM according to the channel's convention (for example, @bot) to send commands. OAgent will orchestrate tools using the same logic as web and return conclusions.
  • For scheduled tasks, you can choose to deliver results to a specified channel when creating the task. For more information, see Create a scheduled task.
  • For some reporting skills, if the conclusion is too long, an abstract is automatically generated and a details link is provided in the session, allowing you to easily navigate to the report page to view the complete content.

What to do next

  • You can monitor channel usage statistics. For more information, see Usage statistics.

Previous topic

Skill Management
Last

Next topic

Built-in knowledge base
Next
on this page
Supported access channels
When to use
Prerequisites
Procedure
Usage
What to do next