oda-whatsapp-cm v1.2.5

Oracle Digital Assistant / Whatsapp-CM integration

This module will create a webhook server that could act as a middleware between oracle digital assistant and whatsapp business account as provided by CM.com.

installation

npm install oda-whatsapp-cm

Useage

const webhook = require('oda-whatsapp-cm');
require('dotenv').config()

const options = {
    port: process.env.PORT, //required
    sender_number: process.env.SENDER_NUMBER, //required
    bot_webhook_url: process.env.BOT_WEBHOOK_URL, //required
    bot_webhook_secret: process.env.BOT_WEBHOOK_SECRET, //required
    cm_product_token: process.env.PRODUCT_TOKEN, //required
    //cm_url_endpoint: process.env.CM_URL_ENDPOINT, //optional
    //outbound_endpoint: process.env.OUTBOUND_ENDPOINT, //optional 
    //inbound_endpoint: process.env.INBOUND_ENDPOINT //optional 
    //ssl_certificate: 'path/to/your/SSL.cert', //optional
    //private_key: 'path/to/your/PRT.key' //optional
}

webhook(options);

HTTPS webhook

• In order to create an HTTPS webhook you simply need to mention the entire path to your SSL certificate and private key.

const options = {
    port: process.env.PORT,
    sender_number: process.env.SENDER_NUMBER,
    bot_webhook_url: process.env.BOT_WEBHOOK_URL,
    bot_webhook_secret: process.env.BOT_WEBHOOK_SECRET,
    cm_product_token: process.env.PRODUCT_TOKEN,
    ssl_certificate: 'path/to/your/SSL.cert',
    private_key: 'path/to/your/PRT.key'
}

• If you do not mention the private key and certificate, the server will by default be HTTP.

Some useless detailes ;)

• REQUIREDport: => The port on which you want to run the server.
• REQUIREDbot_webhook_url: => ODA channel url.
• REQUIREDbot_webhook_secret: => ODA channel secret.
• REQUIREDcm_product_token: => Product token provided by CM.com.
• REQUIREDsender_number: => number of senders whatsapp business account.
• OPTIONALcm_url_endpoint: => Default endpoint provided, change only if required.
• OPTIONALoutbound_endpoint: => Endpoint on which ODA will send replies, defaults to '/bot/receive', change only if required.
• OPTIONALinbound_endpoint: => Endpoint on which whatsapp will send messages, defaults to '/user/send', change only if required.
• OPTIONALssl_certificate: => Full path of your SSL certificate file.
• OPTIONALprivate_key: => Full path of your private key file.

note

You need to set autonumberpostback to true from ODA side, as whatsapp is a text only channel.

Whats New!?

• Attachments including Images and PDF Documents are now supported.
• You can now create an HTTPS webhook by mentioning SSL certificate and private key path.