Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Support for WhatsApp Channel via WhatsApp Cloud API #676

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

ivarunseth
Copy link

This pull request introduces support for integrating WhatsApp as a messaging channel in the Botpress Messaging Server, leveraging the WhatsApp Cloud API. The implementation enables chatbot interactions on WhatsApp, expanding the platform's reach and providing users with a popular and widely used communication medium.

Key Features:

  • WhatsApp Channel Integration: Added the capability to connect and interact with users on WhatsApp through the WhatsApp Cloud API.
  • Renderer Support: Implemented support for various message renderers to ensure a seamless experience. This includes text, image, audio, video, document, and button templates.
  • Exclusions: Carousel renderer support is not included in this implementation and will be considered for future updates.

Implementation Details:

  1. WhatsApp API Client:

    • Integrated the WhatsApp Cloud API to handle message sending and receiving.
    • Added configuration options for WhatsApp credentials and settings.
  2. Message Handling:

    • Extended message handling logic to support WhatsApp-specific message types and formats.
    • Implemented parsers and formatters for converting messages between Botpress and WhatsApp formats.
  3. Renderer Support:

    • Text messages: Simple and multi-line text messages.
    • Media messages: Support for images, audio files, videos, and documents.
    • Interactive messages: Buttons and quick replies.
  4. Documentation:

    • Updated README and documentation files.

Testing:

  • Conducted extensive testing to ensure reliability and compatibility with the WhatsApp Cloud API.
  • Verified the correct rendering of supported message types across different devices.
  • Ensured smooth fallback and error handling mechanisms are in place.

Future Work:

  • Implement support for Carousel renderers to complete the full range of message types.
  • Continuously monitor and update the integration to accommodate any changes in the WhatsApp API.

Notes:

  • These changes require an update in Botpress Studio to support whatsapp channel.

By integrating WhatsApp, this update significantly enhances the versatility and usability of the Botpress Messaging Server, enabling developers to create richer, more engaging chatbot experiences. Looking forward to feedback and suggestions for further enhancements.


@ivarunseth ivarunseth requested a review from a team as a code owner June 18, 2024 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant