Skip to content

Latest commit

 

History

History
371 lines (262 loc) · 18 KB

README.md

File metadata and controls

371 lines (262 loc) · 18 KB
Raw

Features

  • Instagram
  • WhatsApp
  • Facebook Messenger
  • Message delivery status indication
  • Reactions
  • Bot support

Requirements

Changes

  • All messenger workflow will be handled by lhc core, so less bugs.
  • Instagram support added
  • Required scopes are defined in the settings file.

To manage instagram and whatsapp they both has to be matched to you page

Permissions we request from facebook during login

Default scopes. You can change those in settings/settings.ini.php file

'email','pages_show_list','pages_messaging','instagram_manage_messages',
'instagram_basic','pages_manage_metadata','pages_read_engagement',
'whatsapp_business_management','whatsapp_business_messaging','business_management'

Webhook configuration and subscription fields

Webhooks configuration place

See image

Products you should have

See image

Facebook messenger

In webhooks page you have to choose Page and subscribe to those fields

Subscribed fields - message_deliveries,message_echoes,message_edits,message_reactions,message_reads,messages,messaging_postbacks

Instagram

In webhooks page you have to choose Instagram and subscribe to those fields

Subscribed fields - messages,messages,messaging_postbacks,messaging_seen

WhatsApp

In webhooks page you have to choose Whatsapp Business Account and subscribe to those fields

Subscribed fields - messages

Most common URL

URL if you are using Facebook Login flow without automated hosting environment

This is the most common installation method and you choose what page you managed during login flow.

Webhook URL's. Use same URL for webhook verification calls.

  • Facebook Messenger - https://example.com/fbmessenger/callbackgeneral
  • WhatsApp - https://example.com/fbmessenger/callbackwhatsapp
  • Instagram - https://example.com/fbmessenger/callbackinstagram

Valid OAuth Redirect URIs

  • https://example.com/site_admin/fbmessenger/fbcallback

Quick settings

Webhook URL for facebook messenger if you define independent page

You create a facebook app and add pages manually to lhc back office without login flow.

  • Facebook Messenger - https://example.com/fbmessenger/callback/<page_id>
  • Verify token you enter manually in back office in that case

URL if you are using Facebook Login flow with automated hosting environment

Valid OAuth Redirect URIs. master.example.com in this scenario is our manager address

  • https://master.example.com/site_admin/fbmessenger/fbcallbackstandalone

Webhook URL's. Use same URL for webhook verification calls.

  • Facebook Messenger - https://master.example.com/fbmessenger/callbackstandalone
  • WhatsApp - https://master.example.com/fbmessenger/callbackstandalonewhatsapp
  • Instagram - https://master.example.com/fbmessenger/callbackstandaloneinstagram

Quick settings

Facebook messenger extension

Integration with Facebook messenger API. You will be able to chat with Facebook page users directly in lhc back office.

  • Bot support. [New] https://www.youtube.com/watch?v=_rLPJAdn4Us Supported bot elements
    • Text messages including Quick Replies - Send Text
    • Typing - Send typing
    • Carrousel - Send Carrousel
    • Buttons - Button list
    • All other triggers including internal operations also will work.
    • To listed for "Get Started" button action just listen for text message with content "GET_STARTED" also see demo bot in official demo.
  • Support multiple pages without creating new app for each page.
  • Supports multiple pages at once.
  • Each page chat can be assigned to custom department.

Update instructions

  • Make sure you have most recent Live Helper Chat version.
  • Update database via php cron.php -s site_admin -e fbmessenger -c cron/update_structure command
  • Modules -> Facebook chat -> Save and Activate WhatsApp configuration. Click it if you are using WhatsApp integration.

Installation in your LHC server

  • Upload the files to your lhc_web/extension/fbmessenger folder
  • Install database either by executing doc/install.sql file or executing this command php cron.php -s site_admin -e fbmessenger -c cron/update_structure
  • Install dependencies using composer
  • Activate extension in main settings file lhc_web/settings/settings.ini.php extension section fbmessenger by Adding lines:
'extensions' =>  array (  'fbmessenger',  ),
  • If you don't see this in Module, check your lhc_web/settings/settings.ini.php and also click Clean Cache from back office
  • copy extension/fbmessenger/settings/settings.ini.default.php to extension/fbmessenger/settings/settings.ini.php

WhatsApp configuration

Notice - WhatsApp campaigns etc are supported only for statically defined WhatsApp accounts. Login based WhatsApp phone numbers for campaigns will be added later.

This configuration option is available with Permanent Access Token. In facebook Extension settings you have to enter

Few documentation links in Meta platform

!fbtemplate {"template_name":"hello_world","template_lang":"en_us","args":{}}
!fbtemplate {"template_name":"quick_reply","template_lang":"en","args":{"field_1":"name","field_header_1":"header"}}

See image

From WhatsApp perspective we support images, text, video, audio, contact, location, sticker, document messages types

To send campaign of template messages this cronjob has to be setup.

How to listen for quick reply actions from templates you send?

Each quick reply button send from lhc get's payload constructed as.

$item->template.'-quick_reply_'.$indexButton, => quick_reply-quick_reply_0

This is needed because we don't have chat upfront and can't set payload upfront.

So just listen for Custom text matching with that keyword. This sample is provided in bot sample

I have bot for default department, but I want chat go directly to pending state if I send a template?

You have few options

  • Setup quick reply button in your template and listen for those events in your bot
  • While sending a message template choose a department without a bot.
    • We will look for message template without a chat and assign new chat to selected department.

Important

  • In all those scenarios Visitor should NOT have any active chat, otherwise his message will go to active chat and the above rules won't be applied.
  • In incoming webhook configuration FacebookWhatsApp in Chat options choose If previous chat is found and it is closed we should => Create a new chat

Gotchas

  • While app is in testing mode received callback phone number and received callback numbers can be different. E.g
    • 3706111111 received from callback
    • To send this number back you have to set 37086111111. Notice 8
  • After you activate extension to handle this problem you might need to edit incoming webhook rule
    • This rule depends on phone number you have
    • Chat ID field replace rule set to /^370/is
    • Chat ID field replace value set to 3708

Cronjobs

This cronjob sends scheduled campaign messages and regular mass messages Should be run every minute or more frequent.

php cron.php -s site_admin -e fbmessenger -c cron/masssending

Collects campaign recipients and puts them in the main mass messages queue. Should be run every minute or more frequent.

php cron.php -s site_admin -e fbmessenger -c cron/whatsapp_campaign

One page one app installation workflow

This method is usefull if you are planning to use this extension by creating separate apps for each page you manage.

  • Now you can create facebook page in Modules -> Facebook chat -> Facebook pages -> Register new page (later you will have this info from facebook developer section)
  • While creating facebook page check Application was verified by facebook otherwise we will not send request to facebook. Save page.
  • Once page is created you will see what callback url you have to put in facebook webhook. URL is presented in list. HTTPS is must!
  • Facebook APP has to use 8.0v or newer

Actions to do in developers.facebook.com and Live Helper Chat back office

  • APP secret - Copy App Secret from Settings -> Basic
  • Verify token - put any random string without spaces.
  • Page token - follow steps bellow
  • Click Products + in facebook back office and choose Messenger as product you want to add to your APP
  • Click Messenger -> Settings your app page
  • In Access Tokens section click Add or Removes pages there you will get Token which you have to put in Page token field.
  • Now in Webhooks section of Messenger -> Settings page Edit Callback URL. Facebook to verify callback URL will ask you to enter Verify token and callback url. Callback URL you will see in pages list.
  • In same Webhooks add Page from which you want to receive messages. As subscription fields choose messages, messaging_postbacks, message_deliveries, message_reads, messaging_pre_checkouts, messaging_checkout_updates, messaging_referrals, message_echoes, standby, messaging_handovers, message_reactions

So at the end everything should look like

See image

See image

One account multiple page installation workflow

This workflow is usefull if you are planning to use more than one page per facebook account.

  • Your facebook application has to have "pages_messaging" permission for lhc to be able to extract visitor information and be able to send messages back to lhc. For that you will have to submit application and wait for FB to review it.
  • Set webhook callback to url similar to this. https://example.com/fbmessenger/callbackgeneral verify token you have to put in extension/fbmessenger/settings/settings.ini.php file.
  • Valid OAuth Redirect URLs should look like https://example.com/site_admin/fbmessenger/fbcallback
  • We request these scopes email, pages_show_lis, pages_messaging, pages_messaging_subscriptions
  • If you did everything correctly you should be able to login from facebook and grant access Live Helper Chat to see your pages and subscribe to messages events.

One app multiple servers installation

This scenario is usefull in case you have multiple clients and each client has it's own server or address. You can have one master instance which will act as Master and will forward all incoming request from facebook to correct URL of child server.

To activate that option you have to edit extension/fbmessenger/settings/settings.ini.php and set options similar to below

'standalone' => array (
        'enabled' => true,
        'disable_manual_whatsapp' => false, 
        'secret_hash' => 'random_string_to_out',
        'address' => 'https://mater.example.com' // Master instance address
    ),

In facebook Valid OAuth Redirect URIs has to be changed to E.g

https://mater.example.com/site_admin/fbmessenger/fbcallbackstandalone

Messenger -> Settings Webhooks Callback URL has to be set to

https://mater.example.com/fbmessenger/callbackstandalone

Then Submit to facebook to validate your app

  • Before facebook validates your application keep settings verified false (in your LHC facebook page configuration)*
  • After facebook has reviewed your application set "verified" to YES. So you will be able to send a messages. During testing, if you add some developer, you can set it to true to see how it works.

Finally Make your app public.

  • After facebook has reviewed your application you need to make your app live and available

How it works

Once visitor writes a message in facebook page. You will receive a chat with visitor.

How to debug

in extension/fbmessenger/settings/settings.ini.php change setting to 'enable_debug' => true if you have verified site. Check cache/default.log for more detailed error.

How to grant permission to other facebook user to your page so he can subscribe to messenger

  • Make sure messenger button is activated on your page
  • Switch to your page profile
  • Navigate to https://facebook.com/settings/?tab=profile_access
  • Add a user to your page. It should NOT be People with task access image
  • This facebook user does not need to have full control over your page image

How to install extensions using DigitalOcean?

Execute these commands

/opt/livehelperchat/lhc_upgrade.sh
cd /var/www/git
git clone https://github.com/LiveHelperChat/fbmessenger.git
cd /var/www/git/fbmessenger
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php
php -r "unlink('composer-setup.php');"
./composer.phar install
cd /var/www/html/extension
ln -s /var/www/git/fbmessenger
cp /var/www/html/extension/fbmessenger/settings/settings.ini.default.php /var/www/html/extension/fbmessenger/settings/settings.ini.php 
php cron.php -s site_admin -e fbmessenger -c cron/update_structure

If you are using instance as standalone copy all content from master instance /var/www/html/extension/fbmessenger/settings/settings.ini.php

Activate extension by editing

vi /var/www/html/settings/settings.ini.php

And make extensions section look like

'extensions' => 
  array (
	0 => 'nodejshelper',
	1 => 'lhcphpresque',
	2 => 'fbmessenger',
  ),

Setup cronjob to renew SSL automatically

crontab -e

And add this line

0 */12 * * * /usr/bin/certbot renew --post-hook "systemctl reload nginx" >> /var/log/le-renew.log

Todo

  • Add support for typing indicator
  • Add support for messenger notifications campaigns