2.0.15 • Published 7 days ago

@cmpsr/signalwire v2.0.15

Weekly downloads
-
License
MIT
Repository
github
Last release
7 days 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.15

7 days ago

2.0.14

12 days ago

2.0.13

29 days ago

2.0.12

29 days ago

2.0.11

1 month ago

2.0.10

1 month ago

2.0.9

2 months ago

2.0.8

2 months ago

2.0.7

2 months ago

2.0.6

3 months ago

2.0.5

4 months ago

2.0.4

4 months ago

2.0.3

4 months ago

2.0.2

4 months ago

2.0.1

4 months ago

2.0.0

4 months ago

1.0.11

4 months ago

1.0.12

4 months ago

1.0.10

5 months ago

1.0.9

6 months ago

0.4.0

8 months ago

1.0.2

8 months ago

1.0.1

8 months ago

1.0.0

8 months ago

1.0.8

6 months ago

1.0.7

6 months ago

1.0.6

7 months ago

1.0.5

8 months ago

1.0.4

8 months ago

1.0.3

8 months ago

0.3.29

9 months ago

0.3.28

9 months ago

0.3.27

9 months ago

0.3.26

9 months ago

0.3.25

9 months ago

0.3.24

10 months ago

0.3.23

10 months ago

0.3.22

11 months ago

0.3.21

11 months ago

0.3.20

12 months ago

0.3.19

12 months ago

0.3.18

12 months ago

0.3.17

12 months ago

0.3.16

1 year ago

0.3.15

1 year ago

0.3.14

1 year ago

0.3.13

1 year ago

0.3.12

1 year ago

0.3.11

1 year ago

0.3.9

1 year ago

0.3.10

1 year ago

0.3.8

1 year ago

0.3.0

1 year ago

0.3.6

1 year ago

0.3.5

1 year ago

0.3.7

1 year ago

0.3.2

1 year ago

0.3.1

1 year ago

0.3.4

1 year ago

0.3.3

1 year ago

0.2.0

2 years ago