Integrate ZeroClaw with messaging channels

更新时间:
复制 MD 格式

This integration lets you interact directly with ZeroClaw in group or private chats using natural language.

Prerequisites

Before configuring a messaging channel, purchase and configure a Simple Application Server instance with the ZeroClaw application image, following the steps below or the instructions in the Deploy the ZeroClaw image topic. You can skip this section if you have already done so.

Purchase and configure a Simple Application Server with the ZeroClaw image

Step 1. Purchase a ZeroClaw plan

Important

If you have already purchased a Simple Application Server instance, you can deploy ZeroClaw by reinstalling the OS. When doing so, select the ZeroClaw image from the application images. Reinstalling the OS erases all data on the server's system disk. Back up your data as needed. For more information, see Reinstall OS.

  1. Purchase a Simple Application Server with the ZeroClaw application pre-installed.

  2. On the Simple Application Server page, resource configurations are preset. Review the following parameters to change the configuration.

    • Instance: The memory must be 2 GiB or larger. You can switch plans based on your requirements.

    • Region: The default region is China (Beijing).

    • Purchase configuration: The default subscription period is 12 months. You can change the duration.

Step 2. Configure ZeroClaw

  1. In the Simple Application Server console, click the instance ID on the server card. On the Server Overview page, click the Application Details tab.

  2. In the How to Use ZeroClaw section, under Port Whitelisting, click One-Click Whitelist to open the ZeroClaw service port in the firewall.

    Important
    • To prevent malicious scanning and targeted attacks, ZeroClaw does not use a fixed default port during initialization. Instead, it automatically generates a random port. You can view the ZeroClaw port number in the console.

  3. Under Configure ZeroClaw, click Initialize to configure the Model Studio API key.

    You can configure two types of Model Studio API keys:

    • Coding Plan-exclusive API key (recommended): This plan uses a flat-rate monthly fee model and provides a monthly request quota. Calls that exceed the quota return an error, preventing unexpected costs.

      The Coding Plan currently supports models such as qwen3.5-plus, kimi-k2.5, MiniMax-M2.5, and glm-5.
    • Pay-as-you-go Model Studio API key based on token usage

    You can configure the API key using either System Recommendation or Manual Input. The system recommends the API key for the Model Studio Coding Plan (for predictable costs) and the API key for the Model Studio service in the region closest to your server (for lower latency). If you need to use an API key from a different region or account, select Manual Input.

    • System recommendation (select from a drop-down list)

      Make your selection and click Next.

      Instance region

      Recommended API region

      Coding plan API region

      Chinese mainland regions

      China (Beijing)

      China (Beijing)

      US and Europe regions

      US (Virginia)

      China (Hong Kong) and other regions in Asia

      Singapore

    • Manual input

      Select Manual Input, enter the Model Studio API key and its corresponding region, then click Next.

      image

      Important

      If you manually configure the API key, make sure you select the correct region. Otherwise, model calls will fail.

  4. Access the WebUI panel.

    1. In the Access WebUI Panel section, under Generate pairing code, click Execute Command to obtain and copy the pairing code for the ZeroClaw WebUI.

    2. In the Access WebUI Panel section, under Get WebUI panel address, click Execute Command to obtain the website address. Open the address in your browser and enter the pairing code to start a conversation with the ZeroClaw agent.

The console supports integration with multiple mainstream messaging channels.

Integrate with DingTalk

This section describes how to integrate ZeroClaw with DingTalk to interact with ZeroClaw in DingTalk group or private chats.

1. Create a DingTalk app

  1. Select or create an organization.

    Select organization

    Go to the DingTalk Open Platform. When you log in, the following prompt appears. Select an organization for which you have developer permissions, or select an organization and then obtain developer permissions.

    image

    Create organization

    If no organization is available, use the DingTalk mobile client to scan the QR code below. You are redirected to the organization creation page to create a new organization.

    image

    Your DingTalk mobile client must be version 6.5.45 or later.
  2. Go to the DingTalk Open Platform. In the developer console, click Create Now in the section for automatically creating a ZeroClaw bot.image.png

  3. The platform automatically presets the ZeroClaw bot information. You can modify the configuration based on your business needs and then click OK to create the bot.

    If you need to create multiple apps, we recommend changing the bot name or icon during creation for easier identification later.

    image.png

  4. After the app is created, copy and save its Client ID and Client Secret.

    If you close the window, you can still view the Client ID and Client Secret by navigating to the created app and clicking Credentials and Basic Information in the left-side navigation pane.

    image.png

2. Configure the DingTalk app

  1. Return to the Simple Application Server console. Click the instance ID of the server where ZeroClaw is configured. On the Server Overview page, click the Application Details tab.

  2. In the Channel Configuration > DingTalk section, enter the copied Client ID and Client Secret of the DingTalk app, and then click Apply. Wait for the command to execute successfully.

3. Test the bot

You can test the bot by adding it to a new or existing group chat. In the group, interact with the bot by @mentioning it. Alternatively, you can search for the bot to start a private chat.

Group chat

  1. On the DingTalk group's Group Settings page, click the Bot card. On the Bot Management page, click Add Bot. On the Add Bot page, enter the bot's name in the Search box and select it. Click Add, and then click Finish Adding.image

  2. In the DingTalk group, @mention the bot to interact with it. You can also find the bot by entering its name in the DingTalk search bar to start a private chat.

Private chat

  1. In the search box at the top of DingTalk, search for your bot's name and click its profile picture to start a private chat.image

  2. After entering the private chat, you can start a conversation directly with the bot.

Integrate with Lark

This section shows how to integrate ZeroClaw with Lark. This lets you interact with ZeroClaw in group chats or one-on-one chats.

1. Create a Lark application

  1. Go to the Lark Open Platform, click Create Custom App, enter an application name and description, select an icon, and then click Create.

  2. In the navigation pane on the left, click Credentials & Basic Info. Copy the App ID (in the format cli_xxx) and App Secret.

  3. In the navigation pane on the left, click Permissions Management. Click Bulk Import/Export Permissions, paste the permission JSON configuration, click Next, Confirm New Permissions, and then click Request to Enable.

    JSON configuration file content

    {
      "scopes": {
        "tenant": [
          "aily:file:read",
          "aily:file:write",
          "application:application.app_message_stats.overview:readonly",
          "application:application:self_manage",
          "application:bot.menu:write",
          "cardkit:card:write",
          "contact:user.employee_id:readonly",
          "corehr:file:download",
          "docs:document.content:read",
          "event:ip_list",
          "im:chat",
          "im:chat.access_event.bot_p2p_chat:read",
          "im:chat.members:bot_access",
          "im:message",
          "im:message.group_at_msg:readonly",
          "im:message.group_msg",
          "im:message.p2p_msg:readonly",
          "im:message:readonly",
          "im:message:send_as_bot",
          "im:resource",
          "sheets:spreadsheet",
          "wiki:wiki:readonly"
        ],
        "user": ["aily:file:read", "aily:file:write", "im:chat.access_event.bot_p2p_chat:read"]
      }
    }
  4. In the navigation pane on the left, click Add App Features. Click the Add by Feature tab, find the Bot card, and then click Configure.

  5. Configure event subscriptions.

    1. In the Simple Application Server console, go to the details page of the target instance. In the Application Details > Channel Configuration > Lark section, enter the App ID and App Secret that you obtained, and then click Apply.

    2. In the Lark Open Platform, click Events & Callbacks in the navigation pane on the left. On the Event Configuration tab, click Subscription Method, select Use persistent connection to receive events, and then click Save.

    3. On the Event Configuration page, click Add Event, search for the im.message.receive_v1 (Receive Message) event, and then click Confirm Add.

  6. On the Version Management & Release page, create a version. Enter the App Version and Update Notes, click Save, and then submit for review and release.

2. Configure the bot

You can add the bot to a new or existing group chat. To test the bot, mention it with @bot in a Lark group, or search for it and start a private chat.

To use the bot in an external group, see the document Bots support external groups and one-on-one chats with external users.
  1. Add the bot by choosing ... > Settings > Group Bots > Add Bot.

  2. Click the bot's avatar and then click Send Message to send a private message to the bot.

image

Integrate with QQ

This section describes how to integrate ZeroClaw with QQ to interact with it in a one-on-one chat with a QQ bot.

1. Create a QQ bot

  1. Go to the official Tencent QQ Open Platform website. In the Lobster-specific entrance section below, click Go to use.image

  2. In the mobile login area, scan the QR code to log in to your QQ account.

  3. Click Create Bot to generate a new QQ bot. Save the bot's AppID and AppSecret.

    Important

    Keep the copied key information in a safe place. The QQ bot's AppSecret (bot key) is not stored in plain text. If you view the AppSecret for the first time or forget it, you must regenerate it.

2. Configure the channel in the console

In Application Details > Channel Configuration > QQ, enter the App ID and App Secret that you obtained when you created the bot. Click Apply.

3. Verify the integration

Go to QQ and start a conversation with the bot you created.

image