2.0.29 • Published 8 months ago

@cmpsr/signalwire v2.0.29

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

@cmpsr/signalwire

npm version

npm license

npm downloads

Wrapper over Signalwire API

Features

  • Send sms using the Signalwire API

Installing

Using npm:

$ npm install @cmpsr/signalwire

Using yarn:

$ yarn add @cmpsr/signalwire

Examples

CommonJS usage

const { useSignalwireSms } = require("@cmpsr/signalwire");

ES usage

import { useSignalwireSms } from "@cmpsr/signalwire";

Sending a sms with ExpressJS

const express = require("express");
const { useSignalwireSms } = require("@cmpsr/signalwire");

const app = express();
app.use(express.json());

const signalwireSms = useSignalwireSms();

app.post("/send-sms", async (req, res) => {
  const { message, from, to } = req.body;
  const response = await signalwireSms.send(message, from, to);
  res.json(response);
});

API

useSignalwireSms([, project[, token, contexts]])
const project = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const contexts = ["1", "2"];

const useSignalwireSms = useSignalwireSms(project, token, contexts);
NOTE

If you don't pass the optional parameters it will take those values from your environment variables, so you may want to create a .env file or set global variables into your OS.

# in your .env file
SIGNALWIRE_PROJECT = ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
SIGNALWIRE_TOKEN = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
SIGNALWIRE_CONTEXTS = 1,2

Now, load your variables using the dotenv package

require("dotenv").config();
const { useSignalwireSms } = require("@cmpsr/signalwire");
const signalwireSms = useSignalwireSms();

SMS Instance methods

The available instance methods are listed below.

signalwireSms#send(message: string, from: string, to: string)

Resources

License

MIT

2.0.29

8 months ago

2.0.27

9 months ago

2.0.28

9 months ago

2.0.16

1 year ago

2.0.19

1 year ago

2.0.17

1 year ago

2.0.18

1 year ago

2.0.26

10 months ago

2.0.24

11 months ago

2.0.25

11 months ago

2.0.22

12 months ago

2.0.23

11 months ago

2.0.20

1 year ago

2.0.21

12 months ago

2.0.15

1 year ago

2.0.14

1 year ago

2.0.13

1 year ago

2.0.12

1 year ago

2.0.11

1 year ago

2.0.10

1 year ago

2.0.9

1 year ago

2.0.8

1 year ago

2.0.7

1 year ago

2.0.6

1 year ago

2.0.5

1 year ago

2.0.4

1 year ago

2.0.3

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

1.0.11

1 year ago

1.0.12

1 year ago

1.0.10

2 years ago

1.0.9

2 years ago

0.4.0

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

0.3.29

2 years ago

0.3.28

2 years ago

0.3.27

2 years ago

0.3.26

2 years ago

0.3.25

2 years ago

0.3.24

2 years ago

0.3.23

2 years ago

0.3.22

2 years ago

0.3.21

2 years ago

0.3.20

2 years ago

0.3.19

2 years ago

0.3.18

2 years ago

0.3.17

2 years ago

0.3.16

2 years ago

0.3.15

2 years ago

0.3.14

2 years ago

0.3.13

2 years ago

0.3.12

2 years ago

0.3.11

2 years ago

0.3.9

2 years ago

0.3.10

2 years ago

0.3.8

2 years ago

0.3.0

3 years ago

0.3.6

3 years ago

0.3.5

3 years ago

0.3.7

3 years ago

0.3.2

3 years ago

0.3.1

3 years ago

0.3.4

3 years ago

0.3.3

3 years ago

0.2.0

3 years ago