botbuilder-linebot-connector

Microsoft Bot Framework V3 connector for Line office account

Features

• ready for Microsoft Bot Framework V3
• no need a registered bot on dev.botframework.com, but require a certified line developer account, go to apply trial account
• depend on line and line-message-api packages
• support receiving and sending almost any line message types
• for express framework
• serverless framework support - connector.serverlessWebhock(event)

LINE Messaging API for Node.js

About LINE Messaging API

Please refer to the official API documents for details.

• Developer Documents - https://developers.line.me/messaging-api/overview
• API Reference - https://devdocs.line.me/en/#messaging-api
• Messaging API SDKs - https://developers.line.biz/en/docs/messaging-api/line-bot-sdk/

Installation

1npm install --save botbuilder-linebot-connector

Donate; Buy me a Beer

If you want to thank me, or promote your Issue.

Sorry, but I have work and support for packages requires some time after work. I will be glad of your support and PR's.

Document

• 使用 botframework + botbuilder-linebot-connector + serverless(AWS lambda) + botbuilder-mongodb-storage 連 mongodb cluster 開發 LineBot 入門 1 - http://wolke-codes.blogspot.tw/2018/02/botframework-botbuilder-linebot.html
• 使用 botframework + botbuilder-linebot-connector + serverless(AWS lambda) + botbuilder-mongodb-storage 連 mongodb cluster 開發 LineBot 入門 2 - http://wolke-codes.blogspot.tw/2018/02/botframework-botbuilder-linebot_10.html

Code Sample

• example express - https://github.com/Wolke/botbuilder-linebot-connector-example
• example serverless - https://github.com/Wolke/linebot-serverless-MongoDbStorage-LineConnector-typeScript-starter-Kit

javaScript

1var builder = require("botbuilder")
2var LineConnector = require("botbuilder-linebot-connector");
3
4var express = require('express');
5var server = express();
6
7server.listen(process.env.port || process.env.PORT || 3980, function () {
8    console.log("listening to");
9});
10
11
12var connector = new LineConnector.LineConnector({
13    hasPushApi: false, //you have to pay for push api >.,<
14    autoGetUserProfile:true, //default is false
15    // your line
16    channelId: process.env.channelId || "",
17    channelSecret: process.env.channelSecret || "",
18    channelAccessToken: process.env.channelAccessToken || ""
19});
20
21server.post('/line', connector.listen());
22
23var bot = new builder.UniversalBot(connector)
24
25var push = new builder.Message()
26    .address(<any>a)
27    .addAttachment(new ImageMap(<any>a,
28        "test",
29        "https://www.profolio.com/sites/default/files/styles/1920x1040/public/field/image/Bikini_Girls_adx.jpg?itok=uciEvomy",
30        {
31            "width": 1040,
32            "height": 1040
33        },
34        []
35    ))
36bot.send(push);
37
38bot.dialog("/", s => {
39            try{
40                let u = await connector.getUserProfile(s.message.from.id)
41                console.log("u" + u)
42                if (u === undefined) {
43                    s.send("who said:" + s.message.text)
44                } else {
45                    s.send("hello " + u.displayName)
46                }
47            }catch(e){
48                s.send("can`t get user profile!")
49            }
50            //image map
51            
52        s.send(new builder.Message(s).addAttachment(new ImageMap(s,
53            "test",
54            "https://www.profolio.com/sites/default/files/styles/1920x1040/public/field/image/Bikini_Girls_adx.jpg?itok=uciEvomy",
55            {
56                "width": 1040,
57                "height": 1040
58            },
59            [
60                {
61                    "type": "uri",
62                    "linkUri": "https://google.com/",
63                    "area": {
64                        "x": 0,
65                        "y": 0,
66                        "width": 333,
67                        "height": 1040
68                    }
69                },
70                {
71                    "type": "message",
72                    "label": "good",
73                    "text": "hot",
74                    "area": {
75                        "x": 333,
76                        "y": 0,
77                        "width": 333,
78                        "height": 1040
79                    }
80                },
81            ]
82
83
84        )));
85
86    s.send(new builder.Message(s)
87        /* Sticker  */
88        .addAttachment(
89            new LineConnector.Sticker(s, 1, 1)
90        )
91        /* Location  */
92        .addAttachment(
93            new LineConnector.Location(s, "my test", "中和", 35.65910807942215, 139.70372892916203)
94        )
95        /* Audio file */
96        .addAttachment(
97            new builder.AudioCard(s).media([{
98                url: "https://xxx", //file place must be https
99                profile: "music"
100            }])
101            /* Image file */
102        ).addAttachment(
103            new builder.MediaCard(s).image(builder.CardImage.create(s, 'https://imagelab.nownews.com/?w=1080&q=85&src=http://s.nownews.com/5d/6b/5d6b74b674e643f522ed68ef83053a1f.JPG'))
104            /* Video file */
105        ).addAttachment(
106            new builder.MediaCard(s).media('https://imagelab.nownews.com/?w=1080&q=85&src=http://s.nownews.com/5d/6b/5d6b74b674e643f522ed68ef83053a1f.JPG').image(builder.CardImage.create(s, 'https://imagelab.nownews.com/?w=1080&q=85&src=http://s.nownews.com/5d/6b/5d6b74b674e643f522ed68ef83053a1f.JPG'))
107        )
108    );
109
110
111    /* Dialog */
112    s.send(new builder.Message(s)
113        .addAttachment(
114            new builder.HeroCard(s)
115
116            .title("Classic White T-Shirt")
117            .subtitle("100% Soft and Luxurious Cotton")
118            .text("Price is $25 and carried in sizes (S, M, L, and XL)")
119            .images([builder.CardImage.create(s, 'https://imagelab.nownews.com/?w=1080&q=85&src=http://s.nownews.com/11/b9/11b93df1ec7012f4d772c8bb0ac74e10.png')])
120
121            .buttons([
122                //left text message
123                builder.CardAction.imBack(s, "buy classic gray t-shirt", "Buy"),
124                //set timer
125                new builder.CardAction().type("datatimepicker").title("time"),
126                //postback
127                builder.CardAction.postBack(s, "action=buy&itemid=111", "send data"),
128                //open irl
129                builder.CardAction.openUrl(s, "https://1797.tw", "1797")
130
131            ])
132        )
133    )
134        /* Carosuel */
135          
136        var msg = new builder.Message(s);
137        msg.attachmentLayout(builder.AttachmentLayout.carousel)
138        msg.attachments([
139
140            new builder.HeroCard(s)
141                .title("Classic White T-Shirt")
142                .subtitle("100% Soft and Luxurious Cotton")
143                .text("Price is $25 and carried in sizes (S, M, L, and XL)")
144                .images([builder.CardImage.create(s, 'https://imagelab.nownews.com/?w=1080&q=85&src=http://s.nownews.com/11/b9/11b93df1ec7012f4d772c8bb0ac74e10.png')])
145                .buttons([
146                    builder.CardAction.openUrl(s, "https://1797.tw", "1797"),
147                    new builder.CardAction().type("datatimepicker").title("time"),
148                    builder.CardAction.postBack(s, "action=buy&itemid=111", "send data"),
149                ]),
150            new builder.HeroCard(s)
151                .title("Classic Gray T-Shirt")
152                .subtitle("100% Soft and Luxurious Cotton")
153                .text("Price is $25 and carried in sizes (S, M, L, and XL)")
154                .images([builder.CardImage.create(s, 'https://imagelab.nownews.com/?w=1080&q=85&src=http://s.nownews.com/5d/6b/5d6b74b674e643f522ed68ef83053a1f.JPG')])
155                .buttons([
156                    new builder.CardAction().type("datatimepicker").title("time"),
157                    builder.CardAction.imBack(s, "buy classic gray t-shirt", "Buy"),
158                    builder.CardAction.postBack(s, "action=buy&itemid=111", "send data"),
159                ])
160        ]);
161        s.send(msg)
162
163
164})
165
166
167bot.dialog('leave'
168    , s => {
169        s.send("byebye");
170        //only work in group or room
171        connector.leave();
172
173        s.endDialog()
174
175    }
176).triggerAction({
177    matches: /^leave$/i
178});
179
180bot.on('conversationUpdate', function (message) {
181    // detect event
182    switch (message.text) {
183        case 'follow':
184            break;
185        case 'unfollow':
186            break;
187        case 'join':
188            break;
189        case 'leave':
190            break;
191    }
192    var isGroup = message.address.conversation.isGroup;
193    var txt = isGroup ? "Hello everyone!" : "Hello " + message.from.name;
194    var reply = new builder.Message()
195        .address(message.address)
196        .text(txt);
197    bot.send(reply);
198    bot.beginDialog(message.address, "hello")
199});
200
201bot.dialog("hello", [
202    s => {
203        builder.Prompts.text(s, "go");
204    },
205    (s, r) => {
206        s.send("oh!" + r.response)
207        s.endDialog()
208    }
209])
210

License

The MIT license

#If you like this, Welcome to give me Star