Lark

App · 20 actions

Work with Lark chats, messages, documents, Drive files and Base records.

Actions

ActionWhat it does
Create chatCreate chat.
Create documentCreate document.
Create folderCreate folder.
Create recordCreate record.
Create tableCreate table.
Delete messageDelete message.
Get chatGet chat.
Get documentGet document.
Get document textGet document text.
Get messageGet message.
List chat membersList chat members.
List chatsList chats.
List document blocksList document blocks.
List filesList files.
List messagesList messages.
List recordsList records.
List tablesList tables.
Reply messageReply message.
Send messageSend message.
Update recordUpdate record.

Create chat

Create chat.

Inputs

NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
Chat modechat_modetext
Chat mode.One of: group, topic.
Chat typechat_typetext
Chat type.One of: private, public.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Create document

Create document.

Inputs

Titletitletext
Title.
Folder tokenfolder_tokentext
Folder token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Create folder

Create folder.

Inputs

NamenametextRequired
Name.
Folder tokenfolder_tokentextRequired
Folder token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Create record

Create record.

Inputs

App tokenapp_tokentextRequired
App token.
Tabletable_idtextRequired
Table id.
FieldsfieldsobjectRequired
Fields.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Create table

Create table.

Inputs

App tokenapp_tokentextRequired
App token.
NamenametextRequired
Name.
Default view namedefault_view_nametext
Default view name.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Delete message

Delete message.

Inputs

Message idmessage_idtextRequired
Message id.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Get chat

Get chat.

Inputs

Chatchat_idtextRequired
Chat id.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Get document

Get document.

Inputs

Document iddocument_idtextRequired
Document id.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Get document text

Get document text.

Inputs

Document iddocument_idtextRequired
Document id.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Get message

Get message.

Inputs

Message idmessage_idtextRequired
Message id.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

List chat members

List chat members.

Inputs

Chatchat_idtextRequired
Chat id.
Page sizepage_sizenumber
Page size.From 1 to 100.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

List chats

List chats.

Inputs

Page sizepage_sizenumber
Page size.From 1 to 100.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

List document blocks

List document blocks.

Inputs

Document iddocument_idtextRequired
Document id.
Page sizepage_sizenumber
Page size.From 1 to 100.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

List files

List files.

Inputs

Folder tokenfolder_tokentext
Folder token.
Order byorder_bytext
Order by.One of: EditedTime, CreatedTime.
Directiondirectiontext
Direction.One of: ASC, DESC.
Page sizepage_sizenumber
Page size.From 1 to 100.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

List messages

List messages.

Inputs

Chatchat_idtextRequired
Chat id.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
Sort typesort_typetext
Sort type.One of: ByCreateTimeAsc, ByCreateTimeDesc.
Page sizepage_sizenumber
Page size.From 1 to 100.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

List records

List records.

Inputs

App tokenapp_tokentextRequired
App token.
Tabletable_idtextRequired
Table id.
View idview_idtext
View id.
Page sizepage_sizenumber
Page size.From 1 to 100.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

List tables

List tables.

Inputs

App tokenapp_tokentextRequired
App token.
Page sizepage_sizenumber
Page size.From 1 to 100.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Reply message

Reply message.

Inputs

Message idmessage_idtextRequired
Message id.
TexttexttextRequired
Text.
Reply in threadreply_in_threadtrue/false
Reply in thread.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Send message

Send message.

Inputs

Receive idreceive_idtextRequired
Receive id.
Receive id typereceive_id_typetextRequired
Receive id type.One of: open_id (Open id), user_id (User id), union_id (Union id), email, chat_id (Chat id).
TexttexttextRequired
Text.
Uuiduuidtext
Uuid.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Update record

Update record.

Inputs

App tokenapp_tokentextRequired
App token.
Tabletable_idtextRequired
Table id.
Record idrecord_idtextRequired
Record id.
FieldsfieldsobjectRequired
Fields.

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

On this page