Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

omnichannel_api

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

omnichannel_api

Messentes API which allows sending messages via various channels with fallback options

  • 0.0.2
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
1
Maintainers
1
Weekly downloads
 
Created
Source

Messente Omnichannel API

OmnichannelApi - JavaScript client for Messente Omnichannel API

Installation

For Node.js

npm
npm install omnichannel_api --save
Local development

To use the library locally , first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your omnichannel_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('omnichannel_api') in javascript files from the directory you ran the last command above from.

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

const OmnichannelApi = require('omnichannel_api');

const defaultClient = OmnichannelApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
const basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR_MESSENTE_API_USERNAME';
basicAuth.password = 'YOUR_MESSENTE_API_PASSWORD';

const api = new OmnichannelApi.OmnimessageApi();

const viber = OmnichannelApi.Viber.constructFromObject({
    text: "Hello Viber!",
    sender: "Messente",
});

const sms = OmnichannelApi.SMS.constructFromObject({
    text: "Hello SMS!",
});

const whatsAppText = OmnichannelApi.WhatsAppText.constructFromObject({
    body: "Hello WhatsApp!",
    preview_url: false
});


const whatsapp = OmnichannelApi.WhatsApp.constructFromObject({
    text: whatsAppText
});

const omnimessage = OmnichannelApi.Omnimessage.constructFromObject({
    messages: [whatsapp, viber, sms],
    to:"<phone number in e.164 format"
});

api.sendOmnimessage(omnimessage, (error, data) => {
    if (error) {
        console.error(error);
    } else {
        console.log('API called successfully. Returned data: ', data);
    }
});

Documentation for API Endpoints

All URIs are relative to https://api.messente.com/v1

ClassMethodHTTP requestDescription
OmnichannelApi.DeliveryReportApiretrieveDeliveryReportGET /omnimessage/{omnimessage_id}/statusRetrieves the delivery report for the Omnimessage
OmnichannelApi.OmnimessageApicancelScheduledMessageDELETE /omnimessage/{omnimessage_id}Cancels a scheduled Omnimessage
OmnichannelApi.OmnimessageApisendOmnimessagePOST /omnimessageSends an Omnimessage

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication

FAQs

Package last updated on 30 Oct 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc