Lark channel

Updated at:
Copy as MD

Hello!

To use Alibaba Cloud Exclusive Service seamlessly in the Lark workbench, go to the Alibaba Cloud Value-added Service Console - My Support Plan. Click Enable Multi-channel, add the Lark channel, and follow the guide to complete the configuration.

Entry point for enabling value-added services.

Example of the application in Lark

Example of Lark bot message notifications

Part 1: Configuration steps (about 10 minutes)

Operator: An enterprise administrator or application developer in your Lark organization's developer console.

Core objective: Create a custom enterprise application and grant the necessary permissions to securely connect to our platform.

Step 1: Create a custom enterprise application

  1. Log on to the Lark Open Platform - Developer Console as an enterprise administrator or application developer.

  2. Create a new custom enterprise application. Define an application name and description. We recommend that you include "Alibaba Cloud Exclusive Service" to help your organization members find and access the application.

Step 2: Add application capabilities

In the navigation pane on the left of the application console, find and click Add Application Capability. On this page, add the following two core capabilities to the application:

  1. Web App

    1. Purpose: Allows your team to open and use the Alibaba Cloud Exclusive Service application directly in Lark.

    2. Action: Find the Web App card and click + Add. You can add the desktop homepage URL in Step 4.

  2. Bot

    1. Purpose: After you enable the bot, the Alibaba Cloud Exclusive Service application can send you message notifications so that you do not miss important information.

    2. Action: Find the Bot card and click + Add.

Step 3: Get and provide application credentials

To enable the Lark channel, you must provide the Organization Name, App ID, and App Secret.

  1. Organization Name: In the upper-right corner of the Lark Open Platform, click your profile picture, and then click Personal Center. The Organization Name is displayed below your name. The organization name is also displayed below the upper-left corner of a new application as "Official App@(Organization Name)".

  1. After the application is created, go to the Credentials & Basic Info tab on the application details page. Find and copy the App ID and App Secret.

  1. Paste the Organization Name, App ID, and App Secret into the credential fields in the Alibaba Cloud Value-added Service Console - My Support Plan > Enable Multi-channel > Lark Channel section.

Step 4: Configure the web application URL

After you enter the App ID and App Secret on the Enable Multi-channel page, you will obtain the desktop homepage URL. Enter this URL on the web application configuration page as shown in the following figure.

We recommend that you select Open in a new tab in Lark.

The homepage URL format is shown below. Replace {appId} with your application's App ID:

https://ailink.gts.work/lark/{appId}

image.png

Step 5: Enable application permissions

To ensure that the application functions correctly, such as sending message notifications and displaying information cards, enable the following permissions for the application.

Permission

Description

Official Lark permission description

tenant:tenant:readonly

Gets your basic enterprise information, including the following:

  • Enterprise name

  • Enterprise ID (unique within the Lark platform)

  • Edition (Personal Edition/Team Edition)

  • Enterprise logo

  • Enterprise profile picture

Main purpose: To correctly display your enterprise identity in the application.

Link

application:application:self_manage

Gets application information.

Main purpose: To get the basic information of the application to verify that your application is configured correctly.

Link

im:message:send_as_bot

Lets the application bot send messages to users.

Main purpose: When you are mentioned with an at sign (@) in the web application, the bot sends you a private message to ensure you do not miss important information.

Link

cardkit:card:write

Lets the application create and update message cards.

Main purpose: To send you notifications in a more visually appealing and interactive card format to improve the reading experience.

Link

5.1 Method 1: Batch import

  1. Go to the Lark Developer Console > Application Details > Permission Management and click Batch Import/Export Permissions.

  1. Copy the following JSON code into the import box and click Request to Enable.

{
 "scopes": {
 "tenant": [
 "application:application:self_manage",
 "cardkit:card:write",
 "im:message:send_as_bot",
 "tenant:tenant:readonly"
 ],
 "user": []
 }
}

5.2 Method 2: Manual addition

  1. Quick add: In the Alibaba Cloud Value-added Service Console - My Support Plan > Enable Multi-channel > Lark Channel > Application Configuration section, obtain the one-click add link. Clicking the link redirects you to the Lark Developer Console and lists the permissions to add. Select all permissions and click Confirm to Enable Permissions to complete the process.

The quick add link format is shown below. Replace {appId} with your App ID.

https://open.larksuite.com/app/{appId}/auth?q=application:application:self_manage,tenant:tenant:readonly,im:message:send_as_bot,cardkit:card:write&op_from=openapi&token_type=tenant
  1. Add one by one: You can also go to the Lark Developer Console > Application Details > Permission Management, click Enable Permissions, and then search for the following permissions one by one to add and enable them.

Permission names:
application:application:self_manage
tenant:tenant:readonly
im:message:send_as_bot
cardkit:card:write

Step 6: Security settings

To ensure that the application runs correctly, complete the following security configurations in the Lark Developer Console.

6.1 Configure redirection URL

Add the following addresses to Security Settings > Redirection URL. You can copy the required URLs directly from the Value-added Service Console and paste them into the Lark console for batch modification.

Note

Note: Replace {appId} in the URLs with the actual App ID that you obtained in Step 1. You can find the App ID on the Lark application details page.

https://ailink.gts.work/lark/{appId}
https://ailink.gts.work/lark/{appId}/workbench
https://ailink.gts.work/thirdparty/lark/{appId}/login
https://ailink.gts.work/thirdparty/lark/{appId}/oauth2/callback
https://ailink.gts.work/lark/{appId}/person/inviteToGroup

6.2 Configure H5 trusted domain

In Security Settings > H5 Trusted Domain, add the following domain name:

https://ailink.gts.work

Step 7: Version management and publishing

For the first release and any subsequent application changes, go to Version Management & Publishing. Enter the version number and update description, and then save and publish.

Note

Note: If required, you can set the Application Availability Scope to all members of the organization or to specific members.

Important

Special notes and FAQ

  1. [Network Configuration] IP address whitelist (if any)

    If your corporate network has a strict IP address or domain name whitelist, you must add our application URL to the whitelist. Otherwise, the application will not open correctly in Lark.

  2. [Cost Information] Lark version and API call limits

    • If you use the Free Edition of Lark, the API call limit for custom enterprise applications is 10,000 calls/month.

    • If you use a paid edition of Lark, this limit does not apply.

    • Description: This application's main API call scenario is sending @ mention notifications through a bot. To prevent notification fatigue, each user receives a maximum of one notification every 10 minutes. Estimate your usage based on your team's communication frequency. The 10,000 calls/month limit applies to all APIs. If you use the Free Edition, you must also consider other API calls. For more information about paid APIs, see https://open.larksuite.com/document/server-docs/api-call-guide/server-api-list?charge=all.

Part 2: Alibaba Cloud Exclusive Service application user guide

1. Logon and authorization

In Lark, click the application that you created in Part 1. Complete the authorization, which is for identity verification purposes only, to log on.

2. Main service group

After you enable the Lark channel service, the system automatically attaches the main service group that corresponds to your Enterprise Support plan. You can directly contact your Alibaba Cloud Technical Account Manager (TAM) and other helpdesk staff in the group.

Note

If the main service group is not displayed on your interface, contact your TAM to add it.

2.1 Enterprise service desk

Click Enterprise Service Desk in the main service group to view all associated tickets and participants in the group.

2.2 Submit a ticket

In the main service group, click Self-service Ticket Creation. The system automatically creates a dedicated ticket group and assigns a technical service engineer to handle your issue.

3. Ticket group

You can communicate with technical engineers about specific issues in the dedicated ticket group.

  • If the issue is urgent, click Escalate to speed up the process.

  • For critical failures such as data loss, data corruption, or online service unavailability, click Emergency. We will activate the emergency response mechanism and prioritize handling the issue.

4. Member management

Both the main service group and ticket groups support the Member Management feature.

4.1 Add members

Click Add Members and copy the link in the drawer to invite colleagues to join. The link is valid for 24 hours.

4.2 View member list

In Member Management, you can view:

  • Your enterprise members (colleagues)

  • Alibaba Cloud service team members

5. In-group communication

In the group chat, you can directly @mention relevant Alibaba Cloud service personnel or colleagues to collaborate and resolve issues efficiently.