├── .gitignore ├── .dockerignore ├── Dockerfile ├── package.json ├── app.json ├── README.md ├── src └── app.js └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | npm-debug.log -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | node_modules/ 3 | npm-debug.log 4 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:6 2 | 3 | MAINTAINER xVir 4 | 5 | RUN mkdir -p /usr/app/src 6 | 7 | WORKDIR /usr/app 8 | COPY . /usr/app 9 | 10 | EXPOSE 5000 11 | 12 | RUN npm install 13 | CMD ["npm", "start"] 14 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "api-ai-facebook", 3 | "version": "1.0.0", 4 | "description": "API.AI Facebook Bot", 5 | "main": "src/app.js", 6 | "scripts": { 7 | "start": "node src/app.js", 8 | "test": "echo \"Error: no test specified\" && exit 1" 9 | }, 10 | "author": "Danil Skachkov (https://api.ai)", 11 | "license": "ISC", 12 | "dependencies": { 13 | "apiai": "2.0.5", 14 | "async": "^2.0.0", 15 | "body-parser": "^1.15.2", 16 | "express": "^4.13.3", 17 | "html-entities": "^1.2.0", 18 | "json-bigint": "^0.2.0", 19 | "node-uuid": "^1.4.7", 20 | "request": "^2.73.0" 21 | }, 22 | "repository": { 23 | "type": "git", 24 | "url": "https://github.com/api-ai/api-ai-facebook" 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /app.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "API.AI Facebook integration", 3 | "description": "Api.ai Facebook integration allows you to create Facebook bots with natural language understanding based on Api.ai technology.", 4 | "repository": "https://github.com/api-ai/api-ai-facebook", 5 | "logo": "http://xvir.github.io/img/apiai.png", 6 | "keywords": ["api.ai", "facebook", "natural language"], 7 | "env": { 8 | "APIAI_ACCESS_TOKEN": { 9 | "description": "Client access token for Api.ai", 10 | "value": "" 11 | }, 12 | "FB_VERIFY_TOKEN": { 13 | "description": "Verification code", 14 | "value": "" 15 | }, 16 | "FB_PAGE_ACCESS_TOKEN": { 17 | "description": "Page Access Token", 18 | "value": "" 19 | }, 20 | "APIAI_LANG": { 21 | "description": "Agent language", 22 | "value": "", 23 | "required": false 24 | } 25 | }, 26 | "engines": { 27 | "node": "5.10.1" 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # api-ai-facebook 2 | [![](https://images.microbadger.com/badges/image/xvir/api-ai-facebook.svg)](https://microbadger.com/images/xvir/api-ai-facebook "Get your own image badge on microbadger.com") 3 | 4 | Facebook bot sources for Api.ai integration 5 | 6 | ## Deploy with Heroku 7 | Follow [these instructions](https://docs.api.ai/docs/facebook-integration#hosting-fb-messenger-bot-with-heroku). 8 | Then, 9 | [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) 10 | 11 | ## Deploy with Docker 12 | 13 | ```bash 14 | docker run -it --name fb_bot \ 15 | -p :5000 \ 16 | -e APIAI_ACCESS_TOKEN="API.AI client access token" \ 17 | -e FB_PAGE_ACCESS_TOKEN="Facebook Page Access Token" \ 18 | -e FB_VERIFY_TOKEN="Facebook Verify Token" \ 19 | -e APIAI_LANG="en" \ 20 | xvir/api-ai-facebook 21 | ``` 22 | 23 | ## Note about languages: 24 | When you deploy the app manually to Heroku, the APIAI_LANG not filled with a value. 25 | You need to provide language parameter according to your agent settings in the form of two-letters code. 26 | 27 | * "en" 28 | * "ru" 29 | * "de" 30 | * "pt" 31 | * "pt-BR" 32 | * "es" 33 | * "fr" 34 | * "it" 35 | * "ja" 36 | * "ko" 37 | * "zh-CN" 38 | * "zh-HK" 39 | * "zh-TW" 40 | -------------------------------------------------------------------------------- /src/app.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const apiai = require('apiai'); 4 | const express = require('express'); 5 | const bodyParser = require('body-parser'); 6 | const uuid = require('node-uuid'); 7 | const request = require('request'); 8 | const JSONbig = require('json-bigint'); 9 | const async = require('async'); 10 | 11 | const REST_PORT = (process.env.PORT || 5000); 12 | const APIAI_ACCESS_TOKEN = process.env.APIAI_ACCESS_TOKEN; 13 | const APIAI_LANG = process.env.APIAI_LANG || 'en'; 14 | const FB_VERIFY_TOKEN = process.env.FB_VERIFY_TOKEN; 15 | const FB_PAGE_ACCESS_TOKEN = process.env.FB_PAGE_ACCESS_TOKEN; 16 | 17 | const apiAiService = apiai(APIAI_ACCESS_TOKEN, {language: APIAI_LANG, requestSource: "fb"}); 18 | const sessionIds = new Map(); 19 | 20 | function processEvent(event) { 21 | var sender = event.sender.id.toString(); 22 | 23 | if ((event.message && event.message.text) || (event.postback && event.postback.payload)) { 24 | var text = event.message ? event.message.text : event.postback.payload; 25 | // Handle a text message from this sender 26 | 27 | if (!sessionIds.has(sender)) { 28 | sessionIds.set(sender, uuid.v1()); 29 | } 30 | 31 | console.log("Text", text); 32 | 33 | let apiaiRequest = apiAiService.textRequest(text, 34 | { 35 | sessionId: sessionIds.get(sender) 36 | }); 37 | 38 | apiaiRequest.on('response', (response) => { 39 | if (isDefined(response.result)) { 40 | let responseText = response.result.fulfillment.speech; 41 | let responseData = response.result.fulfillment.data; 42 | let action = response.result.action; 43 | 44 | if (isDefined(responseData) && isDefined(responseData.facebook)) { 45 | if (!Array.isArray(responseData.facebook)) { 46 | try { 47 | console.log('Response as formatted message'); 48 | sendFBMessage(sender, responseData.facebook); 49 | } catch (err) { 50 | sendFBMessage(sender, {text: err.message}); 51 | } 52 | } else { 53 | responseData.facebook.forEach((facebookMessage) => { 54 | try { 55 | if (facebookMessage.sender_action) { 56 | console.log('Response as sender action'); 57 | sendFBSenderAction(sender, facebookMessage.sender_action); 58 | } 59 | else { 60 | console.log('Response as formatted message'); 61 | sendFBMessage(sender, facebookMessage); 62 | } 63 | } catch (err) { 64 | sendFBMessage(sender, {text: err.message}); 65 | } 66 | }); 67 | } 68 | } else if (isDefined(responseText)) { 69 | console.log('Response as text message'); 70 | // facebook API limit for text length is 320, 71 | // so we must split message if needed 72 | var splittedText = splitResponse(responseText); 73 | 74 | async.eachSeries(splittedText, (textPart, callback) => { 75 | sendFBMessage(sender, {text: textPart}, callback); 76 | }); 77 | } 78 | 79 | } 80 | }); 81 | 82 | apiaiRequest.on('error', (error) => console.error(error)); 83 | apiaiRequest.end(); 84 | } 85 | } 86 | 87 | function splitResponse(str) { 88 | if (str.length <= 320) { 89 | return [str]; 90 | } 91 | 92 | return chunkString(str, 300); 93 | } 94 | 95 | function chunkString(s, len) { 96 | var curr = len, prev = 0; 97 | 98 | var output = []; 99 | 100 | while (s[curr]) { 101 | if (s[curr++] == ' ') { 102 | output.push(s.substring(prev, curr)); 103 | prev = curr; 104 | curr += len; 105 | } 106 | else { 107 | var currReverse = curr; 108 | do { 109 | if (s.substring(currReverse - 1, currReverse) == ' ') { 110 | output.push(s.substring(prev, currReverse)); 111 | prev = currReverse; 112 | curr = currReverse + len; 113 | break; 114 | } 115 | currReverse--; 116 | } while (currReverse > prev) 117 | } 118 | } 119 | output.push(s.substr(prev)); 120 | return output; 121 | } 122 | 123 | function sendFBMessage(sender, messageData, callback) { 124 | request({ 125 | url: 'https://graph.facebook.com/v2.6/me/messages', 126 | qs: {access_token: FB_PAGE_ACCESS_TOKEN}, 127 | method: 'POST', 128 | json: { 129 | recipient: {id: sender}, 130 | message: messageData 131 | } 132 | }, (error, response, body) => { 133 | if (error) { 134 | console.log('Error sending message: ', error); 135 | } else if (response.body.error) { 136 | console.log('Error: ', response.body.error); 137 | } 138 | 139 | if (callback) { 140 | callback(); 141 | } 142 | }); 143 | } 144 | 145 | function sendFBSenderAction(sender, action, callback) { 146 | setTimeout(() => { 147 | request({ 148 | url: 'https://graph.facebook.com/v2.6/me/messages', 149 | qs: {access_token: FB_PAGE_ACCESS_TOKEN}, 150 | method: 'POST', 151 | json: { 152 | recipient: {id: sender}, 153 | sender_action: action 154 | } 155 | }, (error, response, body) => { 156 | if (error) { 157 | console.log('Error sending action: ', error); 158 | } else if (response.body.error) { 159 | console.log('Error: ', response.body.error); 160 | } 161 | if (callback) { 162 | callback(); 163 | } 164 | }); 165 | }, 1000); 166 | } 167 | 168 | function doSubscribeRequest() { 169 | request({ 170 | method: 'POST', 171 | uri: "https://graph.facebook.com/v2.6/me/subscribed_apps?access_token=" + FB_PAGE_ACCESS_TOKEN 172 | }, 173 | (error, response, body) => { 174 | if (error) { 175 | console.error('Error while subscription: ', error); 176 | } else { 177 | console.log('Subscription result: ', response.body); 178 | } 179 | }); 180 | } 181 | 182 | function isDefined(obj) { 183 | if (typeof obj == 'undefined') { 184 | return false; 185 | } 186 | 187 | if (!obj) { 188 | return false; 189 | } 190 | 191 | return obj != null; 192 | } 193 | 194 | const app = express(); 195 | 196 | app.use(bodyParser.text({type: 'application/json'})); 197 | 198 | app.get('/webhook/', (req, res) => { 199 | if (req.query['hub.verify_token'] == FB_VERIFY_TOKEN) { 200 | res.send(req.query['hub.challenge']); 201 | 202 | setTimeout(() => { 203 | doSubscribeRequest(); 204 | }, 3000); 205 | } else { 206 | res.send('Error, wrong validation token'); 207 | } 208 | }); 209 | 210 | app.post('/webhook/', (req, res) => { 211 | try { 212 | var data = JSONbig.parse(req.body); 213 | 214 | if (data.entry) { 215 | let entries = data.entry; 216 | entries.forEach((entry) => { 217 | let messaging_events = entry.messaging; 218 | if (messaging_events) { 219 | messaging_events.forEach((event) => { 220 | if (event.message && !event.message.is_echo || 221 | event.postback && event.postback.payload) { 222 | processEvent(event); 223 | } 224 | }); 225 | } 226 | }); 227 | } 228 | 229 | return res.status(200).json({ 230 | status: "ok" 231 | }); 232 | } catch (err) { 233 | return res.status(400).json({ 234 | status: "error", 235 | error: err 236 | }); 237 | } 238 | 239 | }); 240 | 241 | app.listen(REST_PORT, () => { 242 | console.log('Rest service ready on port ' + REST_PORT); 243 | }); 244 | 245 | doSubscribeRequest(); 246 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------