An open API service indexing awesome lists of open source software.

https://github.com/donnc/wce

WhatsApp chatbot builders docs
https://github.com/donnc/wce

chatbot engine jawce pywce templates wce whatsapp

Last synced: 3 months ago
JSON representation

WhatsApp chatbot builders docs

Awesome Lists containing this project

README

        

# WCE Documentation

Welcome to **WCE (WhatsApp Chatbot Engine)**, your ultimate solution for building efficient, scalable, and template-driven WhatsApp chatbots.
Whether you're a Python enthusiast or a Java aficionado, WCE offers two robust engines—**PyWCE** for Python and **JaWCE** for Java —
designed to cater to your development preferences without compromising functionality or performance.

## What is WCE?
It is a unified framework that simplifies the creation of WhatsApp chatbots through a **template-driven approach** (Checkout more example templates under [resources](/resources)).
It abstracts the complexities of managing chat workflows and integrates seamlessly with developer-defined business logic using **reflective APIs**.

The framework empowers developers to:
- **Design Conversational Templates**: YAML-defined templates that map out your chatbot's conversational flow.
- **Hook Business Logic**: Integrate your custom logic effortlessly using reflective APIs.
- **Leverage WhatsApp’s Cloud API**: Build reliable chatbots with WhatsApp's powerful messaging platform.

Whether you're looking to create a customer service assistant, automate order processing, or build a dynamic chatbot for your business, WCE provides the tools you need to succeed.

## Why Choose WCE?

### 🚀 **Template-Driven Design**
Define your chatbot's flow using YAML templates, making it easy to visualize and update conversation logic without diving into complex codebases.

### ⚙️ **Flexible APIs**
Both **PyWCE** and **JaWCE** share a similar API structure, ensuring a seamless transition for developers working across Python and Java.

### 🔗 **Reflective API Integration**
Hook your business logic with minimal configuration. WCE’s reflective API maps functions to template hooks dynamically, letting you focus on your application’s core features.

### 🛠 **Cross-Platform Support**
WCE bridges the gap between Python and Java ecosystems, offering:
- **PyWCE**: Optimized for Python developers, leveraging Python’s simplicity and rich libraries.
- **JawCE**: Tailored for Java developers, integrating seamlessly with Java's robust enterprise features.

### 📦 **Modular and Scalable**
Each engine is modular, enabling you to start small and scale effortlessly as your chatbot grows in complexity or user base.

### 💬 **Rich WhatsApp Integration**
Out-of-the-box support for WhatsApp Cloud API features, including text messages, media handling, templates, and interactive elements.

---

## Key Features

- **Easy-to-Use YAML Templates**
Map your chatbot flows, define checkpoints, and create dynamic routes—all in YAML files.

- **Business Logic Hooking**
Link chatbot actions to your custom code functions with a simple dotted path configuration.

- **Interactive Components**
Add buttons, lists, and other interactive elements to your chatbot to enhance user engagement.

- **Developer Tools**
- Sandbox mode for testing.
- Debugging tools to analyze chat flow and errors.

---

## Who is WCE For?

WCE is for developers and businesses that want to:
- Quickly deploy chatbots without sacrificing flexibility.
- Leverage a robust framework tailored to WhatsApp interactions.
- Use their preferred programming language (Python or Java) to build scalable, enterprise-grade solutions.

Whether you're a beginner exploring chatbot development or an expert looking for a reliable engine, WCE has you covered!

---

### Get Started

1. **Choose Your Engine**:
- For Python: [pywce](https://github.com/DonnC/pywce)
- For Java: [jawce](https://github.com/DonnC/jawce)

2. **Explore the APIs**: Both engines share a unified structure for a smooth learning experience.

3. **Build Your First Bot**: Follow the "Getting Started" guide for your chosen engine and start creating amazing WhatsApp bots today!

---

## Join the Community

WCE is not just a framework — it’s a community of innovators and developers. Join us to share ideas, get help, and contribute to the future of WhatsApp chatbot development!

---
Build smarter, faster, and better WhatsApp chatbots with WCE. Let’s get started! 🚀