deno-linebot
🤖 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 { 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’)
Opine server
Using with your own'use strict';
import { linebot } from '../mod.ts'
import { opine, json } from "https://deno.land/x/opine@1.7.2/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 --no-check https://deno.land/x/linebot/example/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 --no-check ./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.
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…).
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…).
LineBot.getGroupMemberProfile(groupId, userId)
Get user profile of a member in a group.
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.
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…).
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.
This is a shorthand for: LineBot.reply(event.replyToken, message)
// reply text message
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);
}
// 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 groupLineBot.getRoomMemberProfile(event.source.roomId, event.source.userId)
if bot is in a chat room
let profiles = await event.joined.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
let profiles = await event.left.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 chatLineBot.getGroupProfile(event.source.groupId)
if bot is in a groupLineBot.getGroupMemberProfile(event.source.groupId, event.source.userId)
if bot is in a groupLineBot.getRoomMemberProfile(event.source.roomId, event.source.userId)
if bot is in a chat room
let profile = await event.source.profile();
await 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 groupLineBot.getRoomMember(event.source.roomId)
if bot is in a chat room
let member = await event.source.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)
let content = await event.message.content();
console.log(content.toString('base64'));
Contribution
Even though deno-linebot is a small project, I hope it can be improving. If there is any issue, please comment and welcome to fork for sending Pull Request. Thanks. :smile:
Contributors
Special thanks to original designer of the linebot project. boybundit/linebot