lark-js-sdk

Third-party JavaScript Lark (Feishu, 飞书) SDK written in TypeScript

Installation

npm install --save lark-js-sdk

Quick Start

Send message to groups that the bot is in:

import {Lark} from 'lark-js-sdk';

async function sendMessage() {
  let lark = new Lark('<YOUR_APP_ID>', '<YOUR_APP_SECRET>');

  let {groups} = await lark.bot.group.getList();

  let chatIds = groups.map(group => group.chat_id);

  for (let chatId of chatIds) {
    let {message_id} = await lark.message.send({
      chat_id: chatId,
      msg_type: 'text',
      content: {text: 'Hello, Lark!'},
    });

    console.log(`Message (${message_id}) sent!`);
  }
}

sendMessage();

Add user

import {Lark} from 'lark-js-sdk';

let lark = new Lark('<YOUR_APP_ID>', '<YOUR_APP_SECRET>');

lark.contact.user
  .add({
    name: 'Dizy',
    mobile: '18900000000',
    department_ids: ['od-234355343342acdbef33'],
    need_send_notification: true,
  })
  .then(data => {
    let {user_info} = data;

    console.log('User added:', user_info);
  });

Use Feishu API Endpoint instead:

import {Feishu, Lark} from 'lark-js-sdk';

let feishu = new Feishu('<YOUR_APP_ID>', '<YOUR_APP_SECRET>');

// or

let feishu = new Lark(
  '<YOUR_APP_ID>',
  '<YOUR_APP_SECRET>',
  'https://open.feishu.cn/open-apis/',
);

// Feishu has the same apis as Lark...

License

MIT, see the LICENSE file for details.