@waynechang65/linebot

Node.js SDK for the LINE Messaging API

Usage no npm install needed!

<script type="module">
  import waynechang65Linebot from 'https://cdn.skypack.dev/@waynechang65/linebot';
</script>

README

linebot

Maintenance npm npm Npm package total downloads Build Status GitHub

!!! Remind:This project is a fork originally from boybundit/linebot. The team seems too busy to maintain this project, so the fork will be maintained continuously here and will update this module as much as possible when LINE releases new APIs.

:exclamation::exclamation::exclamation: NPM Module:@waynchang65/linebot

🤖 SDK for the LINE Messaging API for Node.js

  • Come with built-in server for quick setup
  • Provide convenient addon functions to event object

About LINE Messaging API

Please refer to the official API documents for details.

Installation

$ npm install @waynechang65/linebot --save

Usage

:heavy_exclamation_mark: Notice: Check endpoint of the webhook is the same to 「Webhook URL」 of setting page to LINE Message API. (The demo is 'webhook')

const linebot = require('@waynechang65/linebot');

const endpointToWebHook = 'webhook';

let bot = linebot({
  channelId: CHANNEL_ID,
  channelSecret: CHANNEL_SECRET,
  channelAccessToken: CHANNEL_ACCESS_TOKEN
});

bot.on('message', function (event) {
  event.reply(event.message.text).then(function (data) {
    // success
  }).catch(function (error) {
    // error
  });
});

bot.listen(`/${endpointToWebHook}`, process.env.PORT || 80, function () {
   console.log('LineBot is running. Port : ' + (process.env.PORT || 80));
});

Using with your own Express.js server

const endpointToWebHook = 'webhook';
const app = express();
const linebotParser = bot.parser();
app.post(`/${endpointToWebHook}`, linebotParser);  
app.listen(process.env.PORT || 80, function () {
   console.log('LineBot is running. Port : ' + (process.env.PORT || 80));
});  

Using with AWS Lambda service

module.exports.echo = async (event) => {
   if (bot.verify(event.body, event.headers['x-line-signature'])) {
      var body = JSON.parse(event.body).events[0];
      var replyToken = body.replyToken;
      var userText = body.message.text;

      await bot.reply(replyToken, userText)
         .then(function (data) {
            console.log('Success', data);
         }).catch(function (error) {
            console.log('Error', error);
         });
   } else {
      console.log('Signature authentication error');
   }
};

See examples folder for more examples.

Docker Container DEMO

Run the docker container (waynechang65/linebot) of DEMO code (examples/demo.js) from dockerhub with CHANNEL_ID, CHANNEL_SECRET and CHANNEL_ACCESS_TOKEN. The endpoint is set to be 'webhook' in the docker image.

sudo docker container run -p 3310:80 \
-e CHANNEL_ID="163......." \
-e CHANNEL_SECRET="797...................." \
-e CHANNEL_ACCESS_TOKEN="srd5..............." \
wayne/linebot:latest

:star_struck: It's also possible to dockerize your bot by modifying the dockerfile.

API

LineBot object

linebot(config)

Create LineBot instance with specified configuration.

const bot = linebot({
  channelId: CHANNEL_ID,
  channelSecret: CHANNEL_SECRET,
  channelAccessToken: CHANNEL_ACCESS_TOKEN,
  verify: true // Verify 'X-Line-Signature' header (default=true)
});

Basic

LineBot.listen(webHookPath, port, callback)

Start built-in http server on the specified port, and accept POST request callback on the specified webHookPath.

This method is provided for convenience. You can write you own server and use verify and parse methods to process webhook events. See examples/echo-express-long.js for example.

LineBot.parser()

Create Express.js middleware to parse the request.

The parser assumes that the request body has never been parsed by any body parser before, so it must be placed BEFORE any generic body parser e.g. app.use(bodyParser.json());

LineBot.verify(rawBody, signature)

Verify X-Line-Signature header.

LineBot.parse(body)

Process incoming webhook request, and raise an event.

LineBot.on(eventType, eventHandler)

Raised when a Webhook event is received.

bot.on('message',      function (event) { });
bot.on('follow',       function (event) { });
bot.on('unfollow',     function (event) { });
bot.on('join',         function (event) { });
bot.on('leave',        function (event) { });
bot.on('memberJoined', function (event) { });
bot.on('memberLeft',   function (event) { });
bot.on('postback',     function (event) { });
bot.on('beacon',       function (event) { });

Message

LineBot.reply(replyToken, message)

Reply a message.

See: Event.reply(message)

LineBot.push(to, message)

Send push message.

to is a userId, or an array of userId. A userId can be saved from event.source.userId when added as a friend (follow event), or during the chat (message event).

message can be a string, an array of string, a Send message object, or an array of Send message objects.

LineBot.multicast(to, message)

Send push message to multiple users (Max: 150 users). This is more efficient than push as it will make api call only once.

to is an array of userId.

message can be a string, an array of string, a Send message object, or an array of Send message objects.

LineBot.broadcast(message)

Send push message to all users. This is more efficient than push as it will make api call only once.

message can be a string, an array of string, a Send message object, or an array of Send message objects.

LineBot.getMessageContent(messageId)

Get image, video, and audio data sent by users as a Buffer object.

See: Event.message.content()

LineBot.getQuota()

Get the number of messages quota in the current month.

LineBot.getTotalSentMessagesThisMonth()

Get number of messages sent this month.

LineBot.getTotalReplyMessages(date)

Get number of sent reply messages.

date Date the messages were sent

  • Format: yyyyMMdd (Example: 20210909)
  • Timezone: UTC+9
  • Default date is yesterday (UTC+9).

LineBot.getTotalPushMessages(date)

Get number of sent push messages.

date Date the messages were sent

  • Format: yyyyMMdd (Example: 20210909)
  • Timezone: UTC+9
  • Default date is yesterday (UTC+9).

LineBot.getTotalBroadcastMessages(date)

Get number of sent broadcast messages.

date Date the messages were sent

  • Format: yyyyMMdd (Example: 20210909)
  • Timezone: UTC+9
  • Default date is yesterday (UTC+9).

LineBot.getTotalMulticastMessages(date)

Get number of sent multicast messages.

date Date the messages were sent

  • Format: yyyyMMdd (Example: 20210909)
  • Timezone: UTC+9
  • Default date is yesterday (UTC+9).

Insight

LineBot.getTotalMessagesInsight(date)

Get number of message deliveries

date Date the messages were sent

  • Format: yyyyMMdd (Example: 20210909)
  • Timezone: UTC+9
  • Default date is yesterday (UTC+9).

LineBot.getFriendDemographicsInsight()

Get friend demographics

LineBot.getTotalFollowersInsight(date)

Get the number of users who have added this linebot on or before a specified date.

date Date the messages were sent

  • Format: yyyyMMdd (Example: 20210909)
  • Timezone: UTC+9
  • Default date is yesterday (UTC+9).

Users

LineBot.getUserProfile(userId)

Get user profile information of the user.

userId User ID that is returned in a webhook event object (e.g. U4af4980629...).

See: Event.source.profile(), Event.left.profiles()

Bot

LineBot.getBotInfo()

Get bot info

Group

LineBot.getGroupProfile(groupId)

Get a group profile.

groupId Group ID. Found in the source object of webhook event objects (e.g. Ca56f94637c...).

See: Event.source.profile()

LineBot.getGroupMembersCount(groupId)

Get number of users in a group.

groupId Group ID. Found in the source object of webhook event objects (e.g. Ca56f94637c...).

LineBot.getGroupMember(groupId)

Get userId of all members in a group.

groupId Group ID. Found in the source object of webhook event objects (e.g. Ca56f94637c...).

See: Event.source.member()

LineBot.getGroupMemberProfile(groupId, userId)

Get user profile of a member in a group.

See: Event.joined.profiles()

LineBot.leaveGroup(groupId)

Leave a group.

groupId Group ID. Found in the source object of webhook event objects (e.g. Ca56f94637c...).

Chatroom

LineBot.getRoomMembersCount(roomId)

Get number of users in a room.

roomId Room ID. Found in the source object of webhook event objects.

LineBot.getRoomMember(roomId)

Get userId of all members in a chat room.

roomId Room ID. Found in the source object of webhook event objects.

See: Event.source.member()

LineBot.getRoomMemberProfile(roomId, userId)

Get user profile of a member in a chat room.

roomId Room ID. Found in the source object of webhook event objects.

userId User ID that is returned in a webhook event object (e.g. U4af4980629...).

See: Event.joined.profiles()

LineBot.leaveRoom(roomId)

Leave a room.

roomId Room ID. Found in the source object of webhook event objects.

Account Link

LineBot.getIssueLinkToken(userId)

Issue link token

userId User ID that is returned in a webhook event object (e.g. U4af4980629...).

Event object

Provide convenient shorthands to call LineBot's functions which require parameter from a source event object.

Event.reply(message)

Respond to the event.

message can be a string, an array of string, a Send message object, or an array of Send message objects.

Return a Promise object from node-fetch module.

This is a shorthand for: LineBot.reply(event.replyToken, message)

// reply text message
event.reply('Hello, world').then(function (data) {
  // success
}).catch(function (error) {
  // error
});

// reply multiple text messages
event.reply(['Hello, world 1', 'Hello, world 2']);

// reply message object
event.reply({ type: 'text', text: 'Hello, world' });

// reply multiple message object
event.reply([
  { type: 'text', text: 'Hello, world 1' },
  { type: 'text', text: 'Hello, world 2' }
]);

event.reply({
  type: 'image',
  originalContentUrl: 'https://example.com/original.jpg',
  previewImageUrl: 'https://example.com/preview.jpg'
});

event.reply({
  type: 'video',
  originalContentUrl: 'https://example.com/original.mp4',
  previewImageUrl: 'https://example.com/preview.jpg'
});

event.reply({
  type: 'audio',
  originalContentUrl: 'https://example.com/original.m4a',
  duration: 240000
});

event.reply({
  type: 'location',
  title: 'my location',
  address: '〒150-0002 東京都渋谷区渋谷2丁目21−1',
  latitude: 35.65910807942215,
  longitude: 139.70372892916203
});

event.reply({
  type: 'sticker',
  packageId: '1',
  stickerId: '1'
});

event.reply({
  type: 'imagemap',
  baseUrl: 'https://example.com/bot/images/rm001',
  altText: 'this is an imagemap',
  baseSize: { height: 1040, width: 1040 },
  actions: [{
    type: 'uri',
    linkUri: 'https://example.com/',
    area: { x: 0, y: 0, width: 520, height: 1040 }
  }, {
    type: 'message',
    text: 'hello',
    area: { x: 520, y: 0, width: 520, height: 1040 }
  }]
});

event.reply({
  type: 'template',
  altText: 'this is a buttons template',
  template: {
    type: 'buttons',
    thumbnailImageUrl: 'https://example.com/bot/images/image.jpg',
    title: 'Menu',
    text: 'Please select',
    actions: [{
      type: 'postback',
      label: 'Buy',
      data: 'action=buy&itemid=123'
    }, {
      type: 'postback',
      label: 'Add to cart',
      data: 'action=add&itemid=123'
    }, {
      type: 'uri',
      label: 'View detail',
      uri: 'http://example.com/page/123'
    }]
  }
});

event.reply({
  type: 'template',
  altText: 'this is a confirm template',
  template: {
    type: 'confirm',
    text: 'Are you sure?',
    actions: [{
      type: 'message',
      label: 'Yes',
      text: 'yes'
    }, {
      type: 'message',
      label: 'No',
      text: 'no'
    }]
  }
});

event.reply({
  type: 'template',
  altText: 'this is a carousel template',
  template: {
    type: 'carousel',
    columns: [{
      thumbnailImageUrl: 'https://example.com/bot/images/item1.jpg',
      title: 'this is menu',
      text: 'description',
      actions: [{
        type: 'postback',
        label: 'Buy',
        data: 'action=buy&itemid=111'
      }, {
        type: 'postback',
        label: 'Add to cart',
        data: 'action=add&itemid=111'
      }, {
        type: 'uri',
        label: 'View detail',
        uri: 'http://example.com/page/111'
      }]
    }, {
      thumbnailImageUrl: 'https://example.com/bot/images/item2.jpg',
      title: 'this is menu',
      text: 'description',
      actions: [{
        type: 'postback',
        label: 'Buy',
        data: 'action=buy&itemid=222'
      }, {
        type: 'postback',
        label: 'Add to cart',
        data: 'action=add&itemid=222'
      }, {
        type: 'uri',
        label: 'View detail',
        uri: 'http://example.com/page/222'
      }]
    }]
  }
});

Event.joined.profiles()

Get user profiles information of the sender, when a user joins a group or room.

This is a shorthand for:

  • LineBot.getGroupMemberProfile(event.source.groupId, event.source.userId) if bot is in a group
  • LineBot.getRoomMemberProfile(event.source.roomId, event.source.userId) if bot is in a chat room
event.joined.profiles().then(function (profiles) {
  console.log(profiles);
});

Event.left.profiles()

Get user profiles information of the sender, when a user leave a group or room.

This is a shorthand for:

  • LineBot.getUserProfile(event.source.userId) if it is 1:1 chat
event.left.profiles().then(function (profiles) {
  console.log(profiles);
});

Event.source.profile()

Get user profile information of the sender.

This is a shorthand for:

  • LineBot.getUserProfile(event.source.userId) if it is 1:1 chat
  • LineBot.getGroupProfile(event.source.groupId) if bot is in a group
  • LineBot.getGroupMemberProfile(event.source.groupId, event.source.userId) if bot is in a group
  • LineBot.getRoomMemberProfile(event.source.roomId, event.source.userId) if bot is in a chat room
event.source.profile().then(function (profile) {
  event.reply('Hello ' + profile.displayName);
});

Event.source.member()

Get userId of all members in a group or a chat room.

This is a shorthand for:

  • LineBot.getGroupMember(event.source.groupId) if bot is in a group
  • LineBot.getRoomMember(event.source.roomId) if bot is in a chat room
event.source.member().then(function (member) {
  console.log(member.memberIds);
});

Event.message.content()

Get image, video, and audio data sent by users as a Buffer object.

This is a shorthand for: LineBot.getMessageContent(event.message.messageId)

event.message.content().then(function (content) {
  console.log(content.toString('base64'));
});

Contribution

Welcome to fork and send Pull Request. Thanks. :)

Contributors

Special thanks to original designer of the linebot project. boybundit/linebot

License

MIT