botbuilder-adapter-tyntec-whatsapp

A Microsoft Bot Framework adapter for handling connectivity with the WhatsApp channel in tyntec Conversations API.

Usage no npm install needed!

<script type="module">
  import botbuilderAdapterTyntecWhatsapp from 'https://cdn.skypack.dev/botbuilder-adapter-tyntec-whatsapp';
</script>

README

Tyntec WhatsApp Adapter

A Microsoft Bot Framework adapter for handling connectivity with the WhatsApp channel in tyntec Conversations API.

It is a TypeScript library that allows your bots to use WhatsApp through the tyntec Conversations API. The adapter supports two-way (incoming and outgoing) messaging with templates, free-form and rich media.

Look how easy it is to use:

import axios from 'axios';
import { TyntecWhatsAppAdapter } from 'botbuilder-adapter-tyntec-whatsapp';

const axiosInstance = axios.create();

const adapter = new TyntecWhatsAppAdapter({
    axiosInstance,
    tyntecApikey: 'API_KEY'
});

// ... your bot and server initialization ...

server.post('/api/whatsapp/messages', async (req, res) => {
    await adapter.processActivity(req, res, (context) => myBot.run(context));
});

You can find the full quick start guide in the tyntec Docs Center.

Installation

Install Tyntec WhatsApp Adapter by running:

$ npm install botbuilder-adapter-tyntec-whatsapp

Features

At the moment, the adapter supports only:

  • receiving WhatsApp messages (processActivity),
  • sending WhatsApp messages (sendActivities) and
  • sending WhatsApp messages proactively (continueConversation).

See the API Reference in the docs/ directory for more information about how to use the library and what are the current limitations.

Support

If you are having issues, please let us know

License

This project is distributed under the MIT license.