eurobate-sms
TypeScript icon, indicating that this package has built-in type declarations

0.1.5 • Public • Published

JavaScript library for Eurobate SMS

npm version

This library provides a JavaScript/TypeScript wrapper around the Eurobate JSON APIs.

WARNING: Do not use this library from client side JavaScript, since you will make your password public.

It comes on two flavors.

  • Axios for Node.js (Do not use it in client side JavaScript in the browser)
  • Enonic XP

Usage in Node.js

Install with npm:

npm i eurobate-sms --save

You can now import the library and use the sendSMS function. The TypeScript typings will provide added code security when using it in IDEs.

const { sendSMS } = require('eurobate-sms');
 
sendSMS({
  messages: [
    {
      originator: 'Sender name',
      msisdn: '004740829232',
      message: 'Liten test'
    }
  ],
  user: "myUsername",
  password: "myPassword",
  simulate: 1,
  ttl: 3600
}).then(res => {
  console.log('Response from server:', res);
});

Usage in Enonic

Use npm to install the dependency.

npm i eurobate-sms --save
import { enonicSendSMS } from 'eurobate-sms';
import * as E from "fp-ts/lib/Either";
 
const response = enonicSendSMS({
  messages: [
    {
      originator: 'Sender name',
      msisdn: '004740829232',
      message: 'Liten test'
    }
  ],
  user: "myUsername",
  password: "myPassword",
  simulate: 1,
  ttl: 3600
});
 
E.fold(
  (res) => console.log('Response from server:', res),
  (e) => console.error('Error:', e)
)(response)

Building

To build the project run the following command:

npm run build

/eurobate-sms/

    Package Sidebar

    Install

    npm i eurobate-sms

    Weekly Downloads

    1

    Version

    0.1.5

    License

    MIT

    Unpacked Size

    7.46 kB

    Total Files

    13

    Last publish

    Collaborators

    • tajakobsen