Skip to content

Latest commit

 

History

History
113 lines (99 loc) · 6.63 KB

README.md

File metadata and controls

113 lines (99 loc) · 6.63 KB
Raw

Connecting Platforms: Bidirectional Chat-Bridge for Discord and Messenger

Git_Dissenger

This project allows Discord <-> Facebook Messenger two-way communication.

  • Discord members can send messages to a user at Messenger directly and vice-versa.
  • Users can exchange text, and media including images, gifs, emojis, links, or even files, I embedded the most known formats compatible with the messenger platform.

Requirements:

1. Discord Channel ID.
2. The Discord Channel Webhook (URL)
3. A Discord Bot with permission to read messages in the channel.
4. A server(or VM) to host the Discord Bot
5. Any HTTPS endpoint with a valid TLS or SSL Certificate to receive webhooks notifications and to make post requests to discord webhook (just use FaaS services like Cloud Functions)
6. A Facebook Page/ Business Page for conversation with the target user.
7. Meta Developer Account, Create an App.

About Integration

The Discord bot listens to every message (in the channel) and forwards them to Facebook API, you should host the bot in a server to keep it up and running. A Facebook/Business Page is needed to send messages on behalf of Discord users. Thus by attaching nickname text(bold) to every message, the Facebook user can recognize the sender. Return messages are more straightforward. A cloud function pipes every incoming Facebook message to the webhook belonging to the discord channel.

Part 1: Facebook Messenger to Discord

  1. Obtain your Server ID and Discord Channel's ID.

  2. Get the Discord Channel's Webhook (URL). Discord > Edit Channels > Integrations > Create Webhook > Copy the URL.

  3. Create/Use a Facebook Page, add the target user to the page, and ask the user to start a conversation with your page.

  4. Configure to access Facebook Graph API.

    • Sign-up Meta Developers Platform > Get Started > Create App > Type (Facebook Login for Business).
    • In the App Dashboard > Add products to your app > Messenger > add the Facebook Page

  5. To Send or Receive Messages from user through API you need to add the user as a Tester in your App.

    • The user needs to sign up Meta Developer platform and accept your app request to be a Tester.
    • Go to App Roles > Roles > Add Tester > Enter their Facebook username to send a request.
    • If you want to use the API on any user, you need to switch your App Mode to Live and request Advance Access from Facebook which will take days if you pass the approval.

  6. Construct a Google/Cloud Function. Use the Python scripts in Facebook2Discord. Deploy and obtain your function endpoint URL.

  7. Add the endpoint in your App Menu in step (4). App > Messenger > Settings > Webhooks > Fill your_endpoint/webhook and assign any string as Verify Token.

    • Note the Page ID and Page Access Token (Click Generate Token to get one).
    • Ensure your Page is subscribed to the Webhooks notifications you want to receive.
    • You have to send a POST request to the API to subscribe. Refer Subscribe your Page
    curl -i -X POST "https://graph.facebook.com/PAGE-ID/subscribed_apps?subscribed_fields=messages&access_token=PAGE-ACCESS-TOKEN"

  8. Edit the cloud function. Add Runtime environment variables:

    Name Value
    HUB_VERIFY_TOKEN the string you assigned in your app webhook section Verify Token
    CHANNEL_WEBHOOK your Discord Channel's Webhook (URL)

  9. Edit main.py > go to function post_2_discord > comment out the line dis_data.update(embed_image(data)) and uncomment the line dis_data = {"username": "custom username", "content": str(data)}. Your function should appear like this:

    def post_2_discord(data):
    headers = {"Content-Type": "application/json"}
    dis_data = {"username": "fb user name"} # customize fb username to appear in discord
    try:
        #dis_data.update(embed_image(data))
        # debug mode to return full data
        dis_data = {"username": "custom username", "content": str(data)}
    except Exception as e:
        # return full data + error code if error
        dis_data = {"username": "custom username",
                    "content": str(data)+'ERROR! : '+str(e),
                    }

  10. Deploy the function. When the test user sends a message to your page, a JSON-like string will be posted in your discord channel. Note down the Sender ID. (PSID)

  11. Re-edit the function again. Undo the changes you do in step (10). You can customize fb user name. Deploy function. Done.

Part 2: Discord to Facebook Messenger

  1. Create a Discord Bot, and add it to your Discord server. Give the bot permission at least to read messages in the channel.
  2. Obtain the Bot Client Token and Bot Client ID.
  3. Set up a server to host your discord bot. You can use a local machine or any Virtual Machine in the Cloud. I used Google Compute Engine E2-Micro minimum configuration with Ubuntu 20.04 LTS for this purpose. If you want to run it on Node JS. Install necessary node npm(16): 
    sudo apt update
sudo apt upgrade
sudo apt install nodejs npm
nvm install 16
nvm use 16
    if fails to install nvm 16. Try: 
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
# close and reopen the SSH terminal
- source ~/.bashrc
nvm install 16
nvm use 16
  4. construct .env file, Include all credentials such as Facebook's PAGE ID, MESSENGER_ACCESS_TOKEN (PAGE ACCESS_TOKEN), Discord Server, Channel ID and BOT ID, and TOKEN: 
    # Obtain from Discord Bot Discord developer site
CLIENT_TOKEN= ''
BOT_CLIENT_ID = ''

# Obtain from Discord Server
GUILD_ID = ''
FB_CHANNEL = ''

# Obtain from developer.facebook > your App > Messenger Tab
PAGE_ID = ''
TESTER_PSID = ''
MESSENGER_ACCESS_TOKEN = ''
  5. Refer to the script in Discord2Facebook. Create a new project folder move both index.js, .env files and install dependencies. 
    mkdir discordfb_folder
mv index.js package.json .env discordfb_folder
npm init --if no package.json or good to lock the json
npm install discord.js axios dotenv
  6. Run the bot. node index.js Done.