@sheilim/shimli-sdk

API for sending WhatsApp, CRM, chatbot and more channels such as Facebook Messenger, Instagram and Telegram

Usage no npm install needed!

<script type="module">
  import sheilimShimliSdk from 'https://cdn.skypack.dev/@sheilim/shimli-sdk';
</script>

README

shimli-sdk

Use of the Shimli api to send and read messages from the channels available in Shimli (WhatsApp, SMS, Telegram, Facebook Messanger and Instagram)

Link: https://www.shimli.app

Installation

npm i @sheilim/shimli-sdk --save

How is it used?

Send WhatsApp

const shimli = require('@sheilim/shimli-sdk');

(function(){
    shimli.config['token'] = "YOUR_TOKEN";
    const result = await shimli.sendWhatsApp("chat", "Hi!! 👋", "14243962506", "ID_INSTANCE");
    if(result.error)
        console.log(result.message);
    else
        console.log(result);
})();

Options sendWhatsApp

  • type - string I could be chat, image, video, audio, location, document, sticker, gif
  • body - string Message text or url of the media file to send
  • to - string WhatsApp number to which the message will be sent
  • instance - string Id of the instance connected to Shimli
  • caption - string (optional) Image or video caption
  • filename - string (optional) Name of the document to send
  • lat - string Required if it is of type location
  • lng - string Required if it is of type location

Send Facebook Messenger

const shimli = require('@sheilim/shimli-sdk');

(function(){
    shimli.config['token'] = "YOUR_TOKEN";
    const result = await shimli.sendFbMessenger("text", "Hi!! 👋", "PSID", "ID_INSTANCE");
    if(result.error)
        console.log(result.message);
    else
        console.log(result);
})();

Options sendFbMessenger

  • type - string I could be text, image, video, audio, file
  • body - string Message text or url of the media file to send
  • to - string PSID
  • instance - string Id of the instance connected to Shimli
  • caption - string (optional) Image or video caption

Send WhatsApp Business API

const shimli = require('@sheilim/shimli-sdk');

(function(){
    shimli.config['token'] = "YOUR_TOKEN";
    const result = await sendWhBusinessApi.sendFbMessenger("text", "Hi!! 👋", "14243962506", "ID_INSTANCE");
    if(result.error)
        console.log(result.message);
    else
        console.log(result);
})();

Options sendWhBusinessApi

  • type - string I could be text, image, video, audio, document
  • body - string Message text or url of the media file to send
  • to - string WhatsApp number to which the message will be sent
  • instance - string Id of the instance connected to Shimli
  • caption - string (optional) Image or video caption

Add Lead to Shimli

const shimli = require('@sheilim/shimli-sdk');

(function(){
    shimli.config['token'] = "YOUR_TOKEN";
    const result = await shimli.leadInsert("ID_CLIENT", "ID_INSTANCE", "Insert Lead! 👋", "whatsapp");
    if(result.error)
        console.log(result.message);
    else
        console.log(result);
})();

Options leadInsert

  • to - string PSID (Facebook Messenger) or WhatsApp number
  • instance - string Id of the instance connected to Shimli
  • text - string Lead opening text
  • channel - string whatsapp or fb-messenger
  • area - string (optional) Id area Shimli
  • agent - string (optional) Id agent Shimli
  • process - string (optional) Id process
  • tags - string (optional) example ["customer service", "sales"]