Facebook Bot 開發小技巧

流程

  • 準備環境
  • 使用 ngrok 取得 https 網址
  • 建立與設定 Facebook App 與粉絲團
  • 建立 webhook GET API
  • 設定 Facebook App webhook
  • 實作 webhook POST API 產生對話

準備

由於 Facebook bot 在執行 API 溝通的時候需要使用 SSL 協定即網址要是 https,為了在本地端開發方便。
因此我們需要使用 ngrok 來協助我們產生一個 https 的網址並傳回我們的機器。當然很多文章會介紹您使用 cloudflare 但這邊為了方便開發於是使用另外一種 ssh tunnel 的方式來解決

  1. 註冊並登入 ngrok
  2. 下載並安裝 ngrok
  3. 完成安裝 ngrok 憑證的流程
1
2
3
4
5
6
7
# 安裝可以下載檔案並放置到 /usr/lcoal/bin 或者使用 brew
$ brew cask install ngrok
# 登入後會看到 ngrok 提供的驗證指令
$ ngrok authtoken [your_token]

# 開始使用
$ ngrok http [port]

啟動之後畫面如下:

Imgur

建立 Facebook App 與粉絲專頁

建立好 App 與粉絲團之後接下來為了設定 webhook,網址的部分請給定 ngrok 的網址,例如
https://[hash_code].ngrok.io/webhook。而 token 則是您自訂任意的字串,稍後需要在 API 中使用驗證。

因為設定 webhook 網址時,facebook 會發一個 request 給測試該網址是否正常運作,如果不正確的話,那就沒辦法進入下一階段了。
所以我們需要先將 GET API 建立完成

1
2
3
4
5
6
app.get('/webhook/', function (req, res) {
if (req.query['hub.verify_token'] === '<YOUR CUSTOM TOKEN>') {
res.send(req.query['hub.challenge']);
}
res.send('Error, wrong validation token');
})

一旦設定了若要完全移除就是要讓 API 死掉 8H。

Imgur

Imgur

上敘動作完成之後,我們就完成前置作業了。接著下來就是實作與機器人對談的部分

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
var express = require('express')
var bodyParser = require('body-parser')
var request = require('request')
var app = express()
var token = '<YOUR_PAGE_TOKEN>'
var facebookApi = 'https://graph.facebook.com/v2.6/me/messages'

app.use(bodyParser.urlencoded({
extended: true
}))
app.use(bodyParser.json())

app.get('/', function (req, res) {
res.send('Hi, server')
})

app.get('/webhook/', function (req, res) {
if (req.query['hub.verify_token'] === 'abcd') {
res.send(req.query['hub.challenge']);
}
res.send('Error, wrong validation token');
})

app.post('/webhook/', function (req, res) {
console.log(req.body.entry[0])
var messages = req.body.entry[0].messaging

for (var i = 0; i < messages.length; i++) {
var event = messages[i]
var sender = event.sender.id

if (event.message && event.message.text) {
var text = event.message.text
sendTextMessage(sender, text)
}
}
res.sendStatus(200)
})

app.listen(8080, function () {
console.log('Listen on port 8080')
})

/**
* Functions
*/

function sendTextMessage (sender, text) {
messageData = {
text: text
}

request({
url: facebookApi,
qs: { access_token: token },
method: 'POST',
json: {
recipient: { id: sender },
message: messageData
}
}, function (err, res, body) {
if (err)
console.log('Error sending message: ', err)
else if (res.body.error)
console.log('Error: ', res.body.error)
})
}

到此我們就完成了一個簡單的 Facebook BOT 應用。

作者

andyyou(YOU,ZONGYAN)

發表於

2016-08-26

更新於

2023-12-05

許可協議