deno-linebot

the deno mascot dinosaur standing in the rain

🤖 SDK for the LINE Messaging API for Deno.

Support Opine framework which ported from ExpressJS for Deno
Provide convenient addon functions to event object

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

This is a Deno module available to import direct from this repo and via the Deno Registry.
Before importing, download and install Deno.

You can then import linebot straight into your project:

Import form deno.land

import { linebot } from 'https://deno.land/x/linebot/mod.ts'

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’)

Using with your own Opine server

'use strict';
import { linebot } from 'https://deno.land/x/linebot/mod.ts';
import { opine, json } from 'https://deno.land/x/opine@1.8.0/mod.ts';

const endpointToWebHook = 'webhook';
const options = {
   channelId: CHANNEL_ID,
   channelSecret: CHANNEL_SECRET,
   channelAccessToken: CHANNEL_ACCESS_TOKEN,
   verify: true
};
const bot = linebot(options);
const app = opine();
const linebotParser = bot.parser(json);

app.post(`/${endpointToWebHook}`, linebotParser);

bot.on('message', async (event) => {
   try {
      let 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);
   }
});

const port = parseInt(Deno.env.get('PORT')) || 80;
app.listen(port, () => console.log('LineBot is running. Port : ' + port));

See examples folder for more examples.

Examples

Run the example using Deno directly from GitHub, for example:

deno run --allow-read --allow-env --allow-net https://deno.land/x/linebot/examples/demo.js

Or clone the linebot repo locally:

git clone https://github.com/WayneChang65/deno-linebot.git
cd deno-linebot
deno run --allow-read --allow-env --allow-net ./examples/demo.js

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.parser()

Create Opine 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.

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.