@waynechang65/linebot

v1.2.2

Published

2 years ago

Node.js SDK for the LINE Messaging API

Downloads

0High
0Medium
0Low

waynechang65

LINE Messaging API chat bot linebot nodejs

linebot2

!!! 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.

🤖 linebot2 is SDK for LINE Messaging API for Node.js

NPM Module：@waynchang65/linebot

:question: Why do we use linebot2？

:+1: Reason: Easier and less code

:mag_right: Comparison between @line/line-bot-sdk-nodejs(official) and @waynechang65/linebot2

Compared modules

line-bot-sdk-nodejs：LINE official Message API SDK for node.js
linebot2：Unofficial Message API SDK for node.js and maintained by WayneChang65 with Github community.

Comparison

Base：The simplest echo example. Input text and the bot echos the same text.
Example code：line-bot-sdk-nodejs(official) and linebot2 respective simple echo example file on github repo.

3 parts of the code for the comparison

Part 1: It includes declaration and initialization of used modules, secret and access token of LINE account. Result of the comparison of this part is almost the same between 2 modules.

Part 3: It includes port number setting. Result of the comparison of this part is almost the same between 2 modules.

Part 2: Going back to the second part, this part is also the place where exists a big difference.
- Event handling
  - line-bot-sdk-nodejs(official)：Yes, users must deal with the distribution of events by Promise.all
  - linebot2：No need.
- Handling unused event messages
  - line-bot-sdk-nodejs(official)：Yes, uses must care about and filter out unused event messages.
  - linebot2：No need.
- Deal with the message object
  - line-bot-sdk-nodejs(official)：Yes, users must write code for the return message object.
  - linebot2：No absolutely need.
- Use reply token
  - line-bot-sdk-nodejs(official)：Yes, users must understand what a reply token is, and they must enclose the reply token when sending messages.
  - linebot2：No need. (It’s okay even if the user doesn’t understand what a reply token is)
- Call express api directly
  - line-bot-sdk-nodejs(official)：Yes, users must call express api like status(500).end() when error occurs.
  - linebot2：No need. (It’s okay even if the user isn't familier with express)
- Way to handle event messages
  - line-bot-sdk-nodejs(official)：Included in app.post function and make the programming complicated.
  - linebot2：Use bot.on function to deal with events and make the programming neat and easy.
- Use express
  - line-bot-sdk-nodejs(official)：Yes, users must use express for using the official SDK.
  - linebot2：No absolutely need. (Provide built-in server to optionally use and make it slim)

Conclusion

linebot2 is easier and less code.

About LINE Messaging API

Please refer to the official API documents for details.

Developer Documents - https://developers.line.biz/en/docs/
API Reference - https://developers.line.biz/en/reference/messaging-api/

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', async function (event) {
  try {
    result = await event.reply(event.message.text);
    // Do something here as success
    console.log('Success', result);
  } catch (error) {
    // Do something here to deal with error
    console.log('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..............." \
waynechang65/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',      async function (event) { });
bot.on('follow',       async function (event) { });
bot.on('unfollow',     async function (event) { });
bot.on('join',         async function (event) { });
bot.on('leave',        async function (event) { });
bot.on('memberJoined', async function (event) { });
bot.on('memberLeft',   async function (event) { });
bot.on('postback',     async function (event) { });
bot.on('beacon',       async 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.