mqtt-tools/mqttwarn

[Facebook] Replace `fbchat` service with service based on `messenger-api-python`

Open

#579 opened on Aug 21, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (930 stars) (184 forks)batch import
help wantedservice plugin

Description

Hi there,

coming from @orzechszek's request at #485, we may want to update the code to submit messages to the »Meta« Messenger Platform, which is the official API for chat bots on Facebook today.

It looks like the HTTP calls outlined on [1,2] would be the right way to submit messages these days, when doing it with HTTP only. However, I discovered three libraries on PyPI in this space:

I think messenger-api-python is the most prolific one. Maybe @caronc also wants to have a look in order to add a corresponding adapter to Apprise.

With kind regards, Andreas.

[1] https://developers.facebook.com/docs/messenger-platform/send-messages [2] https://developers.facebook.com/docs/messenger-platform/reference/send-api

Contributor guide

Tech stack
python
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
PythonMQTT basicsREST API fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the existing fbchat service in the codebase (likely in the plugins directory) to understand the current integration pattern. Then evaluate the messenger api python library on PyPI to see how it sends messages via Meta's Messenger Platform API. Check the Apprise project for potential reference implementation. Finally, implement a new service plugin that replaces fbchat with the new library, ensuring compatibility with mqttwarn's notification system.