Lark integration

Listing Lark chats

List the Lark group chats the app's bot is a member of, or search them by group or member name. Returns chat_id, name, description and whether the group includes people from other organizations. Use chat_id to read or post messages. The bot only sees groups it was added to.

Reading Lark messages

Read the message history of a Lark group chat the bot is in, newest page first and each page in chronological order, optionally within a time window. Each message has its message_id (for replies), time, sender name, type and text; media and cards are named by type. Use it to summarize a discussion, find decisions or answer questions about a chat.

Sending Lark message

Send a Markdown message as the app's bot: post in a group chat the bot is in (chat_id), send a direct message to a colleague (email), or reply to a message (reply_to_message_id), optionally in a thread. Supports @-mentions. Everyone in the chat sees it right away.

Looking up Lark colleagues

Look up colleagues in the Lark organization by work email: whether Lark knows them, their open_id (for @-mentions in messages) and, when the app may read contacts, their name and job title. Lark only finds people within the app's availability.

Reading Lark document

Read the title and plain text of a Lark document (docx) the app can open, also a document that is a wiki page. Long documents are cut off at max_characters; `truncated` says so.

Creating Lark document

Create a Lark document with a title and Markdown content: in a folder or wiki space shared with the app, as a sub-page of a wiki page, or in the app's own space. Shares it with the given colleagues and returns its link.

Updating Lark document

Add Markdown content at the end of a Lark document the app may edit, or replace its whole body. Replacing removes the current content; read the document first when parts of it must stay.

Listing Lark folder

List the files in a Lark Drive folder shared with the app, or in the app's own space: docs, sheets, Bases, files and subfolders with their link, type and last edit time, most recently edited first.

Browsing Lark wiki

Without arguments: list the Lark wiki spaces the app can open. With space_id or a wiki link: list the pages in that space or under that page, with their title, type (docx, sheet, bitable, …), node_token and whether they have sub-pages. Read a page's content with the document, sheet or Base tools and the page's wiki link.

Sharing in Lark

Give colleagues access to a Lark document, sheet, Base, file or wiki page by email, as viewer, editor or with full access. The app can only share items it manages, such as what it created. Folders cannot be shared by an app.

Reading Lark Base

Get a Lark Base (Bitable) the app can open: its name, tables, and per table the fields with their type and, for select fields, the options. Call it before searching or writing records, so field and option names are exact.

Searching Lark Base

Search the records of a Lark Base table, optionally in one view, with filter conditions on fields, sorting and a choice of fields; up to 500 records per page. Values come back readable: text, numbers, option names, people's names, dates as ISO times and linked record ids. `total` is the number of matching records.