Support:Manual For Integrating Alibaba Cloud Enterprise Service in Lark

Step 1: Create a Custom App

1. Please log in to [Lark Developer Platform].

2. Create a new Custom App in the platform, define the application name and description (we recommend that you specify Alibaba Cloud Enterprise Service to facilitate queries and access by members of the organization).

Step 2: Add Application Features

Please find and click [Add Features] in the navigation bar on the left side of the application background. On this page, you need to add the following two core features to your app:

1. Web app

   1. Purpose: After adding, your team can directly open and use the "Alibaba Cloud Enterprise Service" application in Lark.

   2. Operation: Please find the "Web app" card, click + to add. You can follow [Step 4] to add desktop-side link.

2. Bot

   1. Purpose: After enabling the bot, the "Alibaba Cloud Enterprise Service" application can send you new message reminders to ensure that you will not miss important information.

   2. Operation: Please find the "robot" card, click + to add.

Step 3: Obtain and provide application credentials

To enable the Lark channel, please provide your organization name, App ID, and App Secret.

1. Organization name: [Lark Open Platform] in the upper right corner and below your name is the "organization name"; The organization name "Production app@ (Organization Name)" will also be displayed below the upper left corner of the new application

2. After the application is successfully created, please find and copy App ID and App Secret on the page-Credentials & Basic Info.

1. Please copy the organization name, application App ID, and App Secret to your TAM for configuration (self-service configuration will be supported later).

Step 4: Configure web app link

Please fill in desktop homepage in the web app configurations. The format of the home page link is as follows. Note that {appId} needs to be replaced with the App ID of your web app:

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

It is recommended to select "New tab in Lark".

Step 5: Activate application permissions

To ensure the normal operation of application functions (such as sending message reminders and displaying information cards), please enable the following permissions for the application.

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

Permission points：
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 normally, please complete the following security settings in the Lark developer 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

https://ailink.gts.work

Step 7: Version Management and Release

For the first and subsequent application changes, please fill in the version number and update description in [Version Management & Release], and then save the release.

Note: You can set the Application Available Range to all or some members of an organization as needed.

Done! Please contact TAM to enter the group

You have completed all configurations, please contact your technical service manager (TAM) to obtain the group joining link. You can communicate with TAM in real time in the application, receive ticket notifications, track service progress, and enjoy the exclusive support experience of seamless integration.

Special instructions and frequently asked questions

1. [Network Configuration] IP Whitelist (if any)

If your enterprise network environment has set up a strict IP or domain name access whitelist, please be sure to add our application website to the whitelist, otherwise the application will not open normally in Lark.

2. [Cost Reminder] Lark Version and API Call Restrictions

   • If you are using the free version of Lark, the upper limit of API calls for custom app is 10,000 per month.

   • If you are using paid version of Lark, there is no such restriction.

   • Note: The main API call scenario of our application is to send @ message reminders through Robots, message reminders will control fatigue, and each user will receive at most once every 10 minutes. Please evaluate this amount based on your team's communication frequency. The above 10000 per month are the total number of calls to all Apis. If you are using the free version, you should also consider other calls. Charged api reference:https://open.larksuite.com/document/server-docs/getting-started/server-api-list?chargeMethod=advanced

Login authorization

Click the newly created application in [Part 1] to complete authorization (only for identification) and log in.

Service main group

After you activate the Lark channel service, the system will automatically bind the corresponding enterprise support plan service group for you. You can directly contact Alibaba Cloud Technical Service Manager (TAM) and other support personnel in the group.

Note: If your interface does not have a service master Group, please contact your technical Service Manager (TAM) to add it for you.

Ticket group

You can communicate with technical engineers on specific issues within the ticket group.

• If the problem is more urgent, you can click [Reminder] to speed up the processing progress;

• In the event of a serious failure such as data loss, data corruption or online business unavailability,Please click [Emergency], we will start the emergency response mechanism, priority intervention.

Group Member Management

The [Gourp Member Management] function is supported by both the service group and the ticket group.

Communication within the group

In the group chat, you can directly @ related Alibaba Cloud service personnel or colleagues to solve problems efficiently and collaboratively.