Channel Deployment Guide

Detailed guide for connecting your AI employee to Telegram or Lark.

Supported Channels

Tip: You can connect multiple channels simultaneously. Your AI employee responds across all connected channels. Pro plan supports Telegram + Lark dual-channel access.

Prerequisites

You do NOT need:

• Any servers or technical infrastructure
• Any coding skills
• API keys or developer accounts
• Any technical knowledge

Option A: Telegram Deployment (Recommended for international users)

Estimated time: 5-8 minutes

Step 1: Create a Telegram Bot

1. Open Telegram, search for @BotFather (official bot manager)

2. Send /newbot command

3. Enter your Bot display name (e.g., My OpenMax)

4. Enter your Bot username (must end with bot, e.g., my_openmax_ai_bot)

5. BotFather returns a Bot Token (format: 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw)

6. Copy and save this Token — you'll need it next

Important: The Bot Token is your bot's unique credential. Do not share it with others.

Step 2: Connect in OpenMax Workspace

1. Log into OpenMax Workspace

2. Open the Channels page and find the Telegram card

3. Paste the Bot Token from Step 1

4. Click Connect

5. System automatically validates the Token and completes connection

Step 3: Start Using

1. In Telegram, search for your Bot username (e.g., @my_openmax_ai_bot)

2. Click Start or send /start

3. Send any message — AI employee responds immediately

4. Deployment complete!

Tip: Telegram is the simplest deployment. No admin permissions needed, no extra configuration. Recommended for first-time users.

Telegram FAQ

Option B: Lark / Feishu Deployment

Estimated time: 8-15 minutes

Note: Adding a self-built app (Bot) in Lark/Feishu requires enterprise admin approval. If you don't want to set up an enterprise Bot right away, you can first create a Lark personal account (international) or Feishu personal account (domestic). You can create and use Bots in your personal workspace without admin approval.

Lark (international) and Feishu (domestic China) have slightly different interfaces. Choose the guide that matches your platform:

Lark Deployment (Recommended for international teams)

Lark offers two deployment options — choose the one that fits your needs:

• Option 1: Smart Agent Quick Deploy (Recommended) — 1-2 minutes, system auto-configures permissions and events, suitable for most users
• Option 2: Custom App Deploy — requires manual permission configuration, event subscription, and version publishing, suitable for advanced users who need fine-grained control

Option 1: Smart Agent Quick Deploy (Recommended)

Estimated time: 1-2 minutes | System auto-configures permissions and event subscriptions — just create a Smart Agent and fill in credentials to complete deployment.

Step 1: Access Lark Open Platform

1. Visit Lark Open Platform

2. Log in with your Lark account

3. Click Developer Backend in the top-right corner

Step 2: Click "Create Now" to Create a Lark Smart Agent App

In the Developer Backend, find the Create Lark Smart Agent App banner at the top and click Create Now on the right side.

Step 3: Fill in Information and Create

1. Choose your preferred avatar

2. Fill in the name (e.g., OpenMax Employee)

3. Click Create Now

Enterprise account note: After creation, if you are using an enterprise Lark account, the enterprise admin must approve the app in the Lark Admin Console before it becomes active. If you are using a personal account, this step is not needed.

Step 4: Fill in Credentials in OpenMax Workspace and Deploy

1. After the Smart Agent is created, you will see the App Created page — copy the App ID and App Secret

2. Log into OpenMax Workspace, click Channels on the left sidebar, select Lark, fill in the App ID and App Secret, then click Connect — the system will automatically deploy your AI employee (typically takes 2-3 minutes)

Step 5: Add Required Permissions for Group Chats

The permissions granted automatically at creation only cover basic messaging. For your AI employee to work properly in group chats and display real user names, manually enable the following 4 scopes:

1. Go back to the Lark Open Platform and click Developer Console in the top-right corner

2. Click the bot you just created and go to Permissions & Scopes

3. Click Enable Scopes, search for each scope ID below, tick it, and click Confirm:

Enterprise account note: On enterprise accounts, permission changes take effect only after the enterprise admin approves them.

Step 6: Search for Bot and Start Chatting

Once connected, search for the bot name you just set up in the top-left corner of the Lark client, confirm the bot has been created, and click to start chatting.

Deployment complete! Your AI employee is now online. You can chat with it directly or add it to group chats.

Option 2: Custom App Deploy (Full Configuration)

Estimated time: 8-15 minutes | Manually create a custom app and configure permissions, event subscriptions, and version publishing step by step. Suitable for advanced users who need fine-grained control.

WebSocket long connection (Recommended): Simplest configuration — only App ID and App Secret needed, no Webhook URL or verification required.

Step 1: Access Lark Open Platform

1. Visit Lark Open Platform

2. Log in with your Lark account

3. Click Developer Backend in the top-right corner

Step 2: Create a Custom App

1. In the Developer Backend, click Create Custom App

2. Enter app name (e.g., OpenMax Employee) and description

3. Click Create to finish

Tip: Enterprise admin permissions are required. If you're not an admin, contact your IT department or use a Lark personal account first.

Step 3: Add Bot Capability

In the app management page, go to Add Capabilities in the left sidebar, find the Bot card, and click "Configure" or "+ Add". After adding, a Bot menu item will appear in the left sidebar.

Important: You must add the Bot capability first before configuring messaging-related permissions (e.g., im:message.group_at_msg:readonly). Otherwise the permission checkbox will be disabled.

After adding, go to Credentials & Basic Info in the left sidebar and note down:

• App ID
• App Secret

Step 4: Configure Permissions

In the app management page, go to Permissions & Scopes. Click Batch Import/Export Permissions, paste the following JSON, and import all permissions at once: Copy JSON

{
  "scopes": {
    "tenant": [
      "contact:contact.base:readonly",
      "contact:user.base:readonly",
      "im:app_feed_card:write",
      "im:chat",
      "im:chat.announcement:read",
      "im:chat.announcement:write_only",
      "im:chat.chat_pins:read",
      "im:chat.chat_pins:write_only",
      "im:chat.collab_plugins:read",
      "im:chat.collab_plugins:write_only",
      "im:chat.labels",
      "im:chat.managers:write_only",
      "im:chat.members:bot_access",
      "im:chat.members:read",
      "im:chat.members:write_only",
      "im:chat.menu_tree:read",
      "im:chat.menu_tree:write_only",
      "im:chat.moderation:read",
      "im:chat.tabs:read",
      "im:chat.tabs:write_only",
      "im:chat.top_notice:write_only",
      "im:chat.widgets:read",
      "im:chat.widgets:write_only",
      "im:chat:create",
      "im:chat:delete",
      "im:chat:moderation:write_only",
      "im:chat:operate_as_owner",
      "im:chat:read",
      "im:chat:readonly",
      "im:chat:update",
      "im:datasync.feed_card.time_sensitive:write",
      "im:message",
      "im:message.group_at_msg:readonly",
      "im:message.group_msg",
      "im:message.group_msg:readonly",
      "im:message.p2p_msg:readonly",
      "im:message.pins:read",
      "im:message.pins:write_only",
      "im:message.reactions:read",
      "im:message.reactions:write_only",
      "im:message.urgent",
      "im:message.urgent:phone",
      "im:message.urgent:sms",
      "im:message:readonly",
      "im:message:recall",
      "im:message:send_as_bot",
      "im:message:send_multi_depts",
      "im:message:send_sys_msg",
      "im:message:update",
      "im:resource",
      "im:url_preview.update",
      "im:user_agent:read"
    ],
    "user": []
  }
}

Scope overview: The scopes above cover contacts (read), chat management (full), messaging (send/receive/recall/pin/react), group @mention listening, urgent messages, file resources, and feed cards. The im:message:send_multi_depts scope replaces the older im:message:send_multi_users name used in previous versions of the platform. The Feishu (domestic China) version uses a slightly smaller scope set — see the Feishu section for details.

Step 5: Configure Event Subscription

1. Return to the Lark Developer Backend, go to Events & Callbacks

2. Under subscription mode, select Receive events through persistent connection

3. Click Add Events and subscribe to:

   • im.message.receive_v1 — Receive messages (required)
   • im.chat.member.bot.added_v1 — Bot added to group (optional)

4. Click Save

Tip: With persistent connection mode, no Request URL is needed — events are received automatically via WebSocket.

Step 6: Create Version and Publish

1. In the Lark Developer Backend, go to Version Management & Publishing

2. Click Create Version

3. Enter version number (e.g., 1.0.0) and update description

4. Confirm app capabilities and permissions, click Save

5. In the confirmation dialog, click Confirm Publish

Admin Approval: After publishing a Lark custom app, the enterprise admin must approve it in the Lark Admin Console before the app becomes active. If you're using a personal account, this step is not needed.

Step 7: Connect in OpenMax Workspace and Deploy

1. Log into OpenMax Workspace

2. Go to the channel configuration page, select Lark

3. Enter the following credentials:

4. Click Connect — the system will automatically deploy your AI employee (typically takes 2-3 minutes)

Tip: With WebSocket long connection, only App ID and App Secret are needed — no Verification Token, Encrypt Key, or Webhook URL required.

Step 8: Enable Bot and Add to Groups

1. In Lark Open Platform, go to Bot menu, confirm bot functionality is enabled

2. Open the Lark client

3. Create or enter a group

4. Click the ... menu in the top-right corner → Settings

5. In Settings, find the Bots option and click it

6. Click Add Bot → search for your app name → add it

7. Enable the group whitelist: the group owner must @mention the bot in the group and send "开启群聊白名单" (enable group whitelist) — only then can other group members use the bot via @mention

8. @mention your bot in the group and send a message

9. AI employee responds → Deployment complete!

Also works in private chat: Search for your app name in Lark and start a direct conversation.

Feishu Deployment (Recommended for domestic China teams)

Feishu offers two deployment options — choose the one that fits your needs:

• Option 1: Smart Agent Quick Deploy (Recommended) — 1-2 minutes, system auto-configures permissions and events, suitable for most users
• Option 2: Custom App Deploy — requires manual permission configuration, event subscription, and version publishing, suitable for advanced users who need fine-grained control

Option 1: Smart Agent Quick Deploy (Recommended)

Estimated time: 1-2 minutes | System auto-configures permissions and event subscriptions — just create a Smart Agent and fill in credentials to complete deployment.

Step 1: Access Feishu Open Platform

1. Visit Feishu Open Platform

2. Log in with your Feishu account

3. Click Developer Backend in the top-right corner

Step 2: Click "Create Now" to Create a Feishu Smart Agent App

In the Developer Backend, find the Create Feishu Smart Agent App banner at the top and click Create Now on the right side.

Step 3: Fill in Information and Create

1. Choose your preferred avatar

2. Fill in the name (e.g., OpenMax Employee)

3. Click Create Now

Enterprise account note: After creation, if you are using an enterprise Feishu account, the enterprise admin must approve the app in the Feishu Admin Console before it becomes active. If you are using a personal account, this step is not needed.

Step 4: Fill in Credentials in OpenMax Workspace and Deploy

1. Log into OpenMax Workspace

2. Click Channels on the left sidebar, select Feishu

3. Go back to the Smart Agent Created Successfully page, copy the App ID and App Secret

4. Fill in the App ID and App Secret, click Connect — the system will automatically deploy your AI employee (typically takes 2-3 minutes)

Step 5: Add Required Permissions for Group Chats

The permissions granted automatically at creation only cover basic messaging. For your AI employee to work properly in group chats and display real user names, manually enable the following 4 scopes:

1. Go back to the Feishu Open Platform and click Developer Console (开发者后台) in the top-right corner

2. Click the bot you just created and go to Permissions & Scopes (权限管理)

3. Click Enable Scopes (开通权限), search for each scope ID below, tick it, and click Confirm:

Enterprise account note: On enterprise accounts, permission changes take effect only after the enterprise admin approves them.

Step 6: Search for Bot and Start Chatting

After connection is complete, search for your bot name in the top-left corner of the Feishu client, confirm the bot has been created correctly, and click to start chatting.

Deployment complete! Your AI employee is now online. You can chat with it directly or add it to group chats.

Option 2: Custom App Deploy (Full Configuration)

Estimated time: 8-15 minutes | Manually create a custom app and configure permissions, event subscriptions, and version publishing step by step. Suitable for advanced users who need fine-grained permission control or custom configuration.

WebSocket (Recommended): Simplest setup — only needs App ID and App Secret, no Webhook URL or verification required.

Webhook (Traditional): Feishu pushes events to a Webhook URL — requires Verification Token configuration.

Step 1: Access Feishu Open Platform

1. Visit Feishu Open Platform

2. Log in with your Feishu account

3. Click Developer Backend in the top-right corner

Step 2: Create an Enterprise App

1. In the Developer Backend, click Create Custom App

2. Enter app name (e.g., OpenMax Employee) and description, select an app icon

3. Click Create to finish

4. After creation, go to Credentials & Basic Info in the left sidebar and note down:

   • App ID
   • App Secret

Tip: Enterprise admin permissions are required. If you're not an admin, contact your IT department or use a Feishu personal account first.

Step 3: Add Bot Capability and Configure Permissions

In the app management page, first add the Bot capability by clicking + Add, then go to Permission Management in the left sidebar.

In the Permission Management page, copy the following JSON and import all permissions at once: Copy JSON

{
  "scopes": {
    "tenant": [
      "contact:contact.base:readonly",
      "contact:user.base:readonly",
      "im:app_feed_card:write",
      "im:chat",
      "im:chat.announcement:read",
      "im:chat.announcement:write_only",
      "im:chat.chat_pins:read",
      "im:chat.chat_pins:write_only",
      "im:chat.collab_plugins:read",
      "im:chat.collab_plugins:write_only",
      "im:chat.managers:write_only",
      "im:chat.members:bot_access",
      "im:chat.members:read",
      "im:chat.members:write_only",
      "im:chat.menu_tree:read",
      "im:chat.menu_tree:write_only",
      "im:chat.moderation:read",
      "im:chat.tabs:read",
      "im:chat.tabs:write_only",
      "im:chat.top_notice:write_only",
      "im:chat.widgets:read",
      "im:chat.widgets:write_only",
      "im:chat:create",
      "im:chat:delete",
      "im:chat:moderation:write_only",
      "im:chat:operate_as_owner",
      "im:chat:read",
      "im:chat:readonly",
      "im:chat:update",
      "im:datasync.feed_card.time_sensitive:write",
      "im:message",
      "im:message.group_at_msg:readonly",
      "im:message.group_msg",
      "im:message.p2p_msg:readonly",
      "im:message.pins:read",
      "im:message.pins:write_only",
      "im:message.reactions:read",
      "im:message.reactions:write_only",
      "im:message.urgent",
      "im:message.urgent:phone",
      "im:message.urgent:sms",
      "im:message:readonly",
      "im:message:recall",
      "im:message:send_as_bot",
      "im:message:send_multi_depts",
      "im:message:send_sys_msg",
      "im:message:update",
      "im:resource",
      "im:url_preview.update",
      "im:user_agent:read"
    ],
    "user": []
  }
}

Feishu vs Lark scopes: The Feishu (domestic China) scope set above differs slightly from the Lark (international) version. Two scopes — im:chat.labels and im:message.group_msg:readonly — are not supported on the Feishu China platform and have been removed. All other scopes are identical.

Step 4: Get Verification Token

1. In app management, go to Events & Callbacks

2. Click the Encryption Strategy tab

3. Find the Verification Token at the bottom of the page, click the eye icon to view and copy it

Tip: On the same page you'll also find the Encrypt Key (optional). If you need encrypted communication, record this as well.

Step 5: Connect in OpenMax Workspace and Deploy

1. Log into OpenMax Workspace

2. Go to the channel configuration page, select Feishu

3. Enter the following credentials:

4. Click Connect — the system will automatically deploy your AI employee (typically takes 2-3 minutes)

5. After deployment, the page will display your dedicated Webhook URL — copy this URL (needed in the next step)

Step 6: Configure Event Subscription

1. Return to the Feishu Developer Backend, go to Events & Callbacks

2. Under "Event Configuration", select Send events to developer server

3. Paste the Webhook URL from the previous step into the Request URL field

4. Subscribe to events:

   • im.message.receive_v1 — Receive messages (required)
   • im.chat.member.bot.added_v1 — Bot added to group (optional)

5. Click Save

Step 7: Create Version and Publish

1. In the Feishu Developer Backend, go to Version Management & Publishing

2. Click Create Version

3. Enter version number (e.g., 1.0.0) and update description

4. Confirm app capabilities and permissions, click Save

5. In the confirmation dialog, click Confirm Publish

Admin Approval: After publishing a Feishu custom app, the enterprise admin must approve it in the Feishu Admin Console before the app becomes active. If you're using a personal account, this step is not needed.

Step 8: Enable Bot and Add to Groups

First, confirm on the Feishu Open Platform that the app status has changed to Enabled (已启用):

1. Open the Feishu client

2. Create or enter a group

3. Click the ... menu in the top-right corner → Settings (设置)

4. In Settings, find the Group Bots (群机器人) option and click it

5. Click Add Bot (添加机器人) → search for your app name → add it

6. Enable the group whitelist: the group owner must @mention the bot in the group and send "开启群聊白名单" (enable group whitelist) — only then can other group members use the bot via @mention

7. @mention your bot in the group and send a message

8. AI employee responds → Deployment complete!

Also works in private chat: Search for your app name in Feishu and start a direct conversation.

Option C: WeChat (微信) Deployment

Estimated time: ~2 minutes

Step 1: Update WeChat (latest version recommended)

1. iOS WeChat 8.0.70 or above

2. Android WeChat 8.0.69 or above

3. Desktop WeChat 4.1.9 or above

Step 2: Log into Workspace → Agent Management → Channels → Scan QR Code with WeChat

Log into Workspace → Agent Management → select your agent and click into it → scroll down to Channels (对话入口) → select WeChat → wait for the QR code to appear → scan it with WeChat on your phone

Step 3: Start Using

1. WeChat on your phone will automatically open the WeChat ClawBot chat page

2. Send any message — your AI employee responds immediately

3. Deployment complete!

Option D: WeCom (企业微信) Deployment

Estimated time: ~5 minutes

Version Note: This guide applies to WeCom component v0.1.1 and above (WebSocket long connection mode — no public IP or SSL required). If you are on the older v0.1.0 webhook mode, upgrade by sending 帮我升级 wecom 组件 via the Workspace Web Console.

Only 2 credentials are required:

Step 1: Create an Intelligent Robot

In the WeCom Admin Console, go to Workbench (工作台) → Intelligent Robots (智能机器人) → click Create Robot (创建机器人).

Step 2: Select Creation Method

In the dialog, click 手动创建 > (Manual Creation), or use AI auto-generation.

Step 3: Switch to API Mode

At the bottom of the page, click 切换至 API 模式创建 (Switch to API Mode Creation).

Step 4: Enable Long Connection and Copy Credentials

1. Select 使用长连接 (Use Long Connection)

2. Copy the Bot ID and Secret displayed on the page

3. Set the Visibility Scope (可见范围) to determine who can use the bot

4. Click Save

Important: The Secret is only shown once at creation. Save it immediately.

Step 5: Connect in Workspace

Log into OpenMax Workspace → go to Agent Management and click the agent to open its detail page → scroll down to the Chat Entry section → click Connect on the WeCom card → enter the Bot ID and Secret from Step 4. Click Connect.

WeCom FAQ

Option E: DingTalk (钉钉) Deployment

Estimated time: 8-12 minutes

Note: DingTalk (钉钉) is Alibaba's enterprise collaboration platform, widely used by Chinese companies. DingTalk uses Stream mode (WebSocket long connection), so no public callback URL is needed — deployment is simpler.

Three credentials are required:

Step 1: Access DingTalk Open Platform and Create an Application

Visit the DingTalk Open Platform App Management page and click Create Application.

Step 2: Enter Application Name and Description

Enter the Application Name (e.g., OpenMax Employee) and Description, then click Save.

Step 3: Add Robot Capability

After saving, you'll be redirected to the "Add Capabilities" page. Click Add Robot capability.

Step 4: Configure Robot and Select Stream Mode

Open the robot configuration page, fill in the required information, select Stream Mode for message reception, then publish.

Note: Stream mode uses WebSocket long connections to receive messages — no public callback URL configuration needed, making deployment simpler.

Step 5: Version Management and Publishing

In the left sidebar, select Version Management & Publishing and click Create New Version.

Step 6: Set Application Visible Scope

Enter the version information, select the appropriate Visible Scope (which team members can see and use the Bot), then save and publish.

Step 7: Get AppKey, AppSecret, and RobotCode

In the application detail page under "Credentials & Basic Info":

• AppKey — application unique identifier
• AppSecret — click "Show" to view

On the robot configuration page, find the RobotCode (usually the same as AppKey).

Step 8: Enter Credentials in Workspace

Enter the AppKey, AppSecret, and RobotCode into the OpenMax Workspace's DingTalk channel configuration page and click Connect.

Step 9: Start Chatting

Search for the Bot name in DingTalk and start chatting with your AI employee.

Group usage: In a DingTalk group chat, @mention your Bot to interact with the AI employee.

DingTalk FAQ

Option F: Slack AI Agent Deployment

Estimated time: 3-5 minutes

Note: Use Slack's AI agent template instead of creating a regular Slack app from scratch. The template automatically creates the bot, enables Socket Mode, and configures the basic permissions and events required for DMs, channel messages, and @mentions.

Slack provides the messaging surface and bot identity. The AI model, memory, tools, and tasks continue to run inside your OpenMax Agent. We recommend one Slack AI Agent app per OpenMax Agent; a single Slack workspace can contain multiple agent apps.

Only two credentials are required:

Step 1: Create a Slack AI Agent

1. Open Slack App Management and sign in.
2. Click Create New App.
3. Select AI agent, then click Continue.

4. Under What should your agent do?, select Starter agent.
5. Enter the agent name. We recommend using the same name as your OpenMax Agent.
6. Select the Slack workspace where the agent will be installed.
7. Click Review Agent, then Create and Install, and approve the installation when prompted.

Why Starter agent? OpenMax already provides the AI model and agent runtime. Slack is the messaging entry point, so the Slack Help desk sample implementation is not needed.

If your workspace requires administrator approval, wait for the installation to be approved before continuing.

Step 2: Copy the Slack credentials

After the app is created, Slack displays Your app credentials. Expand it and copy:

• Bot token, beginning with xoxb-
• App token, beginning with xapp-

Slack may also display instructions to install the Slack CLI, create a project, and run a sample application. You do not need to follow those steps for OpenMax—the Slack connector already runs in your OpenMax cloud instance.

Step 3: Connect the OpenMax Agent

1. Open OpenMax Workspace and navigate to the target Agent's detail page.
2. Find Channels and select Slack.
3. Paste the xoxb-... value into Bot Token.
4. Paste the xapp-... value into App Token.
5. Connect and wait until the status shows connected.

Step 4: Start chatting

1. In Slack, search for the agent name or find it under Apps.
2. Open a DM and send a test message.
3. To use it in a channel, type /invite @AgentName in that channel.
4. Test a channel response with @AgentName your question.

Channels support two trigger modes:

• mention: the Agent responds only when explicitly mentioned. This is recommended for most team channels.
• smart: the Agent can receive normal user messages without an @mention.

mention and smart are OpenMax message-trigger policies. They are separate from Slack's AI agent app template.

Optional: Enable files and images

The Slack AI Agent template includes the permissions and events required for basic text messaging. To let the Agent receive or upload files and images:

1. Open the app's OAuth & Permissions page.
2. Add files:read and files:write under Bot Token Scopes.
3. Click Reinstall to Workspace to apply the new permissions.
4. If Slack issues a new Bot Token, update it in OpenMax Workspace.

Slack FAQ

See Slack's official AI documentation for additional details.

Option G: WhatsApp Deployment

Estimated time: ~5 minutes

Note: WhatsApp connects via QR code scanning (linked device), similar to using WhatsApp Web. No API keys, developer accounts, or app configuration are needed — just a phone with WhatsApp installed.

No credentials are required. You only need:

Step 1: Open the Agent's Chat Entry

1. Log into OpenMax Workspace

2. Go to Agent Management and click the agent you want to deploy to open its detail page

3. Scroll down to the Chat Entry section and find WhatsApp

Step 2: Click WhatsApp "Connect" and Wait for QR Code

1. Click Connect on the WhatsApp card

2. The system will prepare a WhatsApp session in the background — wait for the QR code to generate

3. Once generated, the QR code refreshes automatically every 15 seconds

Important: Do not close the page or click repeatedly while waiting — this may trigger duplicate requests.

Step 3: Open WhatsApp on Your Phone → Linked Devices

1. Open WhatsApp on your phone

2. Tap Me (profile icon) in the bottom-right corner

3. In the settings list, tap Linked Devices

Step 4: Tap "Link a Device" and Scan the QR Code

1. On the "Linked Devices" page, tap the Link a Device button at the bottom

2. Your phone's camera opens — point it at the QR code displayed in Workspace in Step 2

3. Wait a few seconds for the connection to complete

Tip: If the QR code has expired, Workspace will automatically refresh it. Scan the latest QR code displayed.

Step 5: Verify Connection and Manage Chat Permissions

1. After successful scanning, Workspace automatically detects the connection — the WhatsApp card shows Connected

2. One last step: complete the first chat below to become the bot's Owner (administrator)

First Chat Binds You as Owner (Important!)

After connecting, use your own WhatsApp to search for the phone number the bot is bound to and send the bot its first message. This first chat binds you as the bot's Owner (administrator) — all later permission management (such as allowing others to chat) relies on the Owner identity, so this step is essential — do not skip it. When the bot replies automatically, the connection is confirmed live.

Managing Who Can Chat with the Bot

By default, only the Owner can chat with the bot. To allow others to interact, configure access via two modes — just send a natural language instruction to the bot:

Allowlist Mode — Only specified phone numbers can chat:

Send to bot: Enable allowlist mode, add +1 555xxxx888 to the list

The bot will update its configuration automatically. Only users on the allowlist can initiate conversations.

Open Mode — Anyone can chat:

Send to bot: Enable open mode, anyone can DM you

The bot will open chat access to all users.

Note: WhatsApp linked devices may disconnect automatically if the phone is offline for an extended period. If disconnected, return to Workspace and scan the QR code again to reconnect.

WhatsApp FAQ

Option H: Microsoft Teams Deployment

Estimated time: 15-20 minutes

Note: Microsoft Teams is widely used by enterprises on Microsoft 365. Deployment requires creating an Azure Bot resource, configuring permissions, and publishing the app via the Teams Developer Portal. No servers or coding skills needed — a free Azure tier is sufficient.

Four credentials are required:

Step 1: Create an Azure Bot

1. Go to Azure Portal, click Create a resource, and search for Azure Bot

2. Click Create and fill in:

   • Bot handle: a unique name (e.g., openmax-ai-employee)
   • Resource group: select an existing one or create new
   • Pricing tier: F0 (Free)
   • Type of App: Single Tenant
   • Creation type: Create new Microsoft App ID

3. Click Review + create, then Create

4. When deployment completes, click Go to resource

Note: Creating an Azure Bot automatically creates an App Registration for you — no separate step needed.

Step 2: Configure the Bot and Note Credentials

1. In the Azure Bot resource, go to Configuration

2. Set the Messaging endpoint to your agent's MS Teams webhook URL:

   https://<your-agent-domain>/ms-teams/api/messages
   

   You can find this on the Microsoft Teams card in your employee's channel grid on the OpenMax Workspace. Copy it and paste it here.

3. Note down the Microsoft App ID (this is your App ID) and App Tenant ID (this is your Tenant ID)

4. Click Apply

Step 3: Enable the Microsoft Teams Channel

This step is required and easy to miss — the bot will not work in Teams without it.

1. In the Azure Bot resource, go to Channels in the left sidebar

2. Click Microsoft Teams, accept the Terms of Service, and click Apply

3. The Microsoft Teams channel should now appear as Running in the channel list

Important: The Teams channel must be enabled on the Azure Bot resource. Without it, Teams will show an "Invalid Bot" error when users try to chat with the bot.

Step 4: Create a Client Secret

1. On the Configuration page, click Manage Password — this takes you to the App Registration page

2. Go to Certificates & secrets

3. Click New client secret

4. Enter a description (e.g., OpenMax Bot Secret) and choose an expiration period

5. Click Add

6. Copy the secret Value immediately — it is only shown once

Important: The client secret cannot be viewed again after you leave this page. Save it securely. This is your App Password.

Step 5: Configure Graph API Permissions

Instead of adding permissions one by one through the UI, you can paste them all at once via the manifest editor.

1. In the App Registration page (you should already be here from Step 3), go to the Manifest tab

2. Select the Microsoft Graph App Manifest (New) tab at the top

3. Find "requiredResourceAccess": [] and replace only the [] with the following array:

[
  {
    "resourceAppId": "00000003-0000-0000-c000-000000000000",
    "resourceAccess": [
      { "id": "01d4889c-1287-42c6-ac1f-5d1e02578ef6", "type": "Role" },
      { "id": "6b7d71aa-70aa-4810-a8d9-5d9fb2830017", "type": "Role" },
      { "id": "7b2449af-6ccd-4f4d-9f78-e550c193f0d1", "type": "Role" },
      { "id": "df021288-bdef-4463-88db-98f22de89214", "type": "Role" },
      { "id": "9ff7295e-131b-4d94-90e1-69fde507ac11", "type": "Scope" },
      { "id": "ebf0f66e-9fb1-49e4-a278-222f76911cf4", "type": "Scope" },
      { "id": "7427e0e9-2fba-42fe-b0c0-848c9e6a8182", "type": "Scope" }
    ]
  }
]

4. Click Save at the top of the Manifest page

Important: Replace only the empty [] after "requiredResourceAccess": — do not replace the entire line including the key name.

This adds all 7 permissions at once:

Add Redirect URI for Reactions

To enable emoji reactions (💬 thinking indicator, 👍, etc.), add a redirect URI:

1. In the App Registration page, go to Authentication

2. Click + Add a platform → Web

3. Enter the redirect URI: https://<your-agent-domain>/ms-teams/auth/callback (Use the same domain from your Messaging endpoint in Step 2)

4. Click Configure

Grant Admin Consent

After saving the manifest, go to API permissions and click Grant admin consent for [your organization]. Confirm, and all 7 permissions should show a green checkmark.

Important: Admin consent is required. Without it, file downloads, chat history, emoji reactions, and smart mode features will not work.

Step 6: Create App in Teams Developer Portal

1. Go to Teams Developer Portal and sign in

2. Click Apps in the left sidebar, then + New app

3. Enter an app name (e.g., OpenMax Employee)

4. In Basic information, note the App ID shown at the top — this is your App Catalog ID (you'll need it when connecting in the OpenMax Workspace)

5. Fill in the required fields:

   • Short description: e.g., AI-powered digital employee
   • Long description: e.g., OpenMax employee that helps your team with writing, research, translation, data analysis, and daily tasks — right inside Microsoft Teams.
   • Developer name: e.g., OpenMax
   • Website: https://openmax.com
   • Privacy policy: https://docs.openmax.com/privacy-policy
   • Terms of use: https://docs.openmax.com/user-agreement

6. Click Save

Step 7: Configure the App Manifest

1. In the Teams Developer Portal, go to your app's App package → App package editor

2. Paste the following manifest JSON, replacing the two placeholders with your actual values:

   • Replace <TEAMS_APP_ID> (1 place) with the App ID from Step 5 (the App Catalog ID)
   • Replace <AZURE_APP_ID> (2 places) with the App ID from Step 2 (the Azure App Registration ID)

{
  "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.19/MicrosoftTeams.schema.json",
  "version": "1.0.0",
  "manifestVersion": "1.19",
  "id": "<TEAMS_APP_ID>",
  "name": { "short": "OpenMax Employee" },
  "developer": {
    "name": "OpenMax",
    "websiteUrl": "https://openmax.com",
    "privacyUrl": "https://docs.openmax.com/privacy-policy",
    "termsOfUseUrl": "https://docs.openmax.com/user-agreement"
  },
  "description": {
    "short": "AI-powered digital employee",
    "full": "OpenMax employee that helps your team with writing, research, translation, data analysis, and daily tasks — right inside Microsoft Teams."
  },
  "icons": { "outline": "outline.png", "color": "color.png" },
  "accentColor": "#FFD646",
  "bots": [{
    "botId": "<AZURE_APP_ID>",
    "scopes": ["personal", "team", "groupChat"],
    "isNotificationOnly": false,
    "supportsCalling": false,
    "supportsVideo": false,
    "supportsFiles": true
  }],
  "permissions": ["messageTeamMembers"],
  "validDomains": [],
  "webApplicationInfo": {
    "id": "<AZURE_APP_ID>",
    "resource": "https://graph.microsoft.com"
  },
  "authorization": {
    "permissions": {
      "resourceSpecific": [
        { "name": "ChatMessage.Read.Chat", "type": "Application" },
        { "name": "ChannelMessage.Read.Group", "type": "Application" }
      ]
    }
  }
}

3. Click Save at the top of the editor

4. Return to the App package editor page and click the Update button to apply your changes

Note on placeholders: The manifest has two different IDs. <TEAMS_APP_ID> is the App ID from the Teams Developer Portal (Step 5) — it appears once in the id field. <AZURE_APP_ID> is the App ID from Azure (Step 2) — it appears in botId and webApplicationInfo.id.

Step 8: Upload App Icons (Optional)

1. In the Teams Developer Portal, go to your app's Branding section

2. Upload the app icons:

   • Color icon: 192x192 PNG
   • Outline icon: 32x32 PNG with transparent background

3. Click Save

Tip: If you skip this step, Teams will use default placeholder icons.

Step 9: Publish the App

You have two options to distribute the app:

Option A — Publish to your organization:

1. In the Teams Developer Portal, go to Distribute → Publish to org

2. Submit the app for admin approval

3. An admin must approve the app in the Teams Admin Center → Manage apps

4. After approval, users should restart Microsoft Teams to see the new app

Option B — Sideload via app package (for admins):

1. In the Teams Developer Portal, click Download app package to get the .zip file

2. In Microsoft Teams, go to Apps → Manage your apps → Upload a custom app

3. Select the downloaded .zip file

Step 10: Connect in OpenMax Workspace

Important: This step must be done last — all 4 credentials are required.

1. Log into OpenMax Workspace

2. Go to Agent Management and click the agent you want to deploy to open its detail page

3. Scroll down to the Chat Entry section, find the Microsoft Teams card and click Connect

4. Enter the credentials:

5. Click Connect — the system will validate your credentials and deploy the channel

Step 11: Enable Reactions (One-Time Setup)

To activate the 💬 thinking indicator and emoji reactions:

1. Open your browser and visit: https://<your-agent-domain>/ms-teams/auth/sign-in (Use the same domain from your Messaging endpoint)

2. Sign in with your Microsoft 365 account

3. After seeing "Signed in successfully", close the tab

Note: This only needs to be done once. The bot stores the delegated token and uses it automatically for all reactions going forward.

Step 12: Start Chatting

1. In Teams, search for your app name (e.g., OpenMax Employee)

2. Click to start a DM conversation

3. Send any message — AI employee responds immediately

4. Deployment complete!

Tip: To use in group chats or team channels, add the bot to a team or group chat, then @mention it to trigger a response.

Microsoft Teams FAQ

Option I: Zalo (Official) Deployment

Estimated time: ~5 minutes

Note: Zalo (Official) connects via the official Zalo Bot Platform API. Only a personal Zalo account is required — no Official Account (OA) registration, no servers, and no coding skills needed.

One credential is required:

Step 1: Create a Bot on the Zalo Bot Platform

1. Visit the Zalo Bot Platform and log in with your Zalo account

2. Click Create Bot

3. Enter a bot name (e.g., OpenMax) and description

4. After creation, you will see your Bot Token (format: numeric_id:secret)

5. Copy and save this Token — you'll need it in the next step

Important: The Bot Token is your bot's unique credential. Do not share it with others.

Step 2: Connect in OpenMax Workspace

1. Log into OpenMax Workspace

2. Go to Agent Management and click the agent you want to deploy to open its detail page

3. Scroll down to the Chat Entry section, find the Zalo (Official) card and click Connect

4. Paste the Bot Token from Step 1

5. Click Connect — the system will validate the token and complete the connection

Step 3: Start Chatting

1. Open Zalo on your phone or desktop

2. Search for your bot name

3. Send any message — AI employee responds immediately

4. Deployment complete!

First message: The first user to send a DM to the bot becomes the Owner. The owner always has full access regardless of policy settings.

Zalo (Official) FAQ

Option J: Zalo Personal (Unofficial) Deployment

Estimated time: ~2 minutes

Note: Zalo Personal (Unofficial) uses a real Zalo account via QR code scanning — no bot registration, API keys, or developer accounts needed. It connects through zca-js, a reverse-engineered protocol library.

No credentials are required. Authentication is done entirely via QR code:

Step 1: Ask Your AI Employee to Install Zalo Personal (Unofficial)

Message your AI employee in any connected channel (Telegram, Lark, WhatsApp, etc.):

"Install the Zalo Personal (Unofficial) channel"

Your AI employee will install the Zalo Personal (Unofficial) component and generate a QR code, which it sends back to you in the chat.

Step 2: Scan the QR Code with Your Dedicated Zalo Account

1. Open Zalo on the phone logged in to your dedicated bot account (not your personal account)

2. Tap the QR code scanner (usually in the top-right corner of the home screen or in the search bar)

3. Point your camera at the QR code your AI employee sent you

4. Confirm the login on your phone when prompted

Step 3: Connection Confirmed

Your AI employee will confirm the connection is established. Your dedicated Zalo account is now the bot's identity on Zalo.

Step 4: Start Chatting

1. Anyone who sends a message to your dedicated bot Zalo account will receive AI-powered responses

2. Deployment complete!

First message: The first user to send a DM becomes the Owner (administrator). The owner always has full access regardless of policy settings.

Zalo Personal (Unofficial) FAQ

Option K: Discord Deployment

Estimated time: ~8 minutes

Note: Discord connects over the Gateway (WebSocket) — no public callback URL or webhook is required. You only need a Bot Token from the Discord Developer Portal.

One credential is required:

Step 1: Create a Discord Application

1. Visit the Discord Developer Portal and log in

2. Click New Application in the top-right corner

3. Enter a name (e.g., OpenMax Employee) and click Create

Step 2: Add a Bot & Copy the Token

1. In the left sidebar, go to the Bot tab

2. Click Reset Token (or Add Bot if prompted), then confirm

3. Copy the Bot Token and save it somewhere safe

Important: The Bot Token is shown only once. If you lose it, you'll need to reset it and copy the new one.

Step 3: Enable the Message Content Intent (required)

1. Still on the Bot tab, scroll to Privileged Gateway Intents

2. Toggle Message Content Intent ON

3. Save your changes

Important: Without the Message Content Intent enabled, the bot receives empty message text and cannot read what users send.

Step 4: Invite the Bot to Your Server

1. In the left sidebar, go to OAuth2 → URL Generator

2. Under Scopes, select bot

3. Under Bot Permissions, select:

   • View Channels
   • Send Messages
   • Read Message History
   • Attach Files
   • Add Reactions

4. Copy the generated URL at the bottom and open it in your browser

5. Choose the server to add the bot to, then click Authorize

Note: DMs work without a server invite — a server invite is only needed for server/channel use.

Step 5: Connect in OpenMax Workspace

1. Log into OpenMax Workspace

2. Go to Agent Management and click the agent you want to deploy to open its detail page

3. Scroll down to the Chat Entry section, find the Discord card and click Connect

4. Paste the Bot Token from Step 2

5. Click Connect — the system will validate the token and complete the connection

Step 6: Start Chatting

1. DM the bot directly, or @mention it in a server channel

2. Send any message — AI employee responds immediately

3. Deployment complete!

First message: The first person to DM the bot becomes the Owner (administrator). The owner always has full access regardless of policy settings.

Discord FAQ

Option L: LINE Deployment

Estimated time: 5-10 minutes

LINE connects with two credentials — a Channel Access Token and a Channel Secret — plus a Webhook URL that Workspace generates for you. You do not need the numeric Channel ID.

Step 1: Create a LINE Official Account + Messaging API channel

1. Go to the LINE Official Account Manager and create (or open) an Official Account.

2. Open Settings → Messaging API and click Enable Messaging API, then select or create a provider and agree to the terms.

3. This creates a Messaging API channel in the LINE Developers Console.

Step 2: Get your credentials

1. In the LINE Developers Console, open your provider → the channel.

2. Channel secret — copy it from the Basic settings tab (also shown on the OA Manager Messaging API screen).

3. Channel access token (long-lived) — open the Messaging API tab, scroll to Channel access token, click Issue, and copy the token.

Important: Both values are secrets — don't share them. The numeric Channel ID is not required.

Step 3: Connect in OpenMax Workspace

1. Log into OpenMax Workspace, go to Agent Management, click the agent to open its detail page, and scroll down to the Chat Entry section (or use the Channels step in the hire flow).

2. Find the LINE card and click Connect.

3. Paste the Channel Access Token and Channel Secret from Step 2.

4. Click Connect — the system validates the token and deploys your LINE channel.

5. Once connected, the card shows a Webhook URL (e.g. https://<your-subdomain>.icoco.ai/line/webhook). Copy it.

Step 4: Set the webhook in LINE

1. Back in the LINE Developers Console → Messaging API tab → Webhook settings.

2. Paste the Webhook URL from Step 3 and click Save, then turn Use webhook ON.

3. In the LINE Official Account Manager → Settings → Response settings: turn Webhooks ON and turn Auto-response messages OFF — so your AI employee (not LINE's auto-responder) handles messages.

Step 5: Start Chatting

1. Add your Official Account as a friend — scan its QR code in OA Manager, or search its Basic ID (e.g. @xxxxxxx).

2. Send any message — your AI employee responds immediately.

3. Deployment complete!

First message: The first user to DM the account becomes the Owner (administrator), who always has full access regardless of policy settings.

LINE FAQ

Option M: WhatsApp Business (Official API) Deployment

Estimated time: ~5 minutes

Note: This channel uses Meta's official WhatsApp Business Platform (Cloud API). You bring a phone number, verify it with a one-time code right in the Workspace, and OpenMax handles everything on the Meta side — no Meta developer account, API keys, or QR/phone linking needed. Prefer linking a regular WhatsApp account by QR code instead? See WhatsApp.

No credentials are required. You only need:

Step 1: Click Connect on the WhatsApp Business Card

1. Log into OpenMax Workspace, go to Agent Management and click the agent to open its detail page

2. Scroll down to the Chat Entry section, find the WhatsApp Business card and click Connect

Step 2: Enter Your Phone Number and Display Name

1. Enter the phone number you want to use, in international format (e.g. +1 555 123 4567)

2. Enter a display name — this is the business name your customers will see in WhatsApp

3. Check the preview carefully before continuing

Important: The display name is reviewed against Meta's display name policy and is hard to change later — choose it carefully.

Step 3: Verify with the One-Time Code

1. Meta sends a 6-digit verification code to your number via SMS (a voice call option is available if SMS doesn't arrive)

2. Enter the code in the wizard

Mainland China numbers: SMS delivery to +86 numbers can be unreliable — if the code doesn't arrive, use the voice call option.

Step 4: Deploy

1. After the code is verified, the system registers your number and deploys the channel automatically — a progress indicator shows each step

2. When finished, the WhatsApp Business card shows Connected

Step 5: Start Chatting

1. From any phone with WhatsApp, send a message to your business number

2. Your AI employee responds immediately — deployment complete!

First message: The first user to DM the business number becomes the Owner (administrator), who always has full access regardless of policy settings.

WhatsApp Business FAQ