@cmpsr/signalwire NPM

@cmpsr/signalwire

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

Changelog

License

MIT

@signalwire/js @signalwire/realtime-api axios

@infinitebrahmanuniverse/nolb-_cm @everything-registry/sub-chunk-181

2.0.29

10 months ago

2.0.29-canary-20241025074050

10 months ago

2.0.29-canary-20241025071430

10 months ago

2.0.29-canary-20241025100435

10 months ago

2.0.28-canary-20241009182444

10 months ago

2.0.28-canary-20241009200356

10 months ago

2.0.28-canary-20241009175710

10 months ago

2.0.27

11 months ago

2.0.28

10 months ago

2.0.28-canary-20241009201626

10 months ago

2.0.17-canary-20240530101527

1 year ago

2.0.17-canary-20240528105525

1 year ago

2.0.23-canary-20240730092540

1 year ago

2.0.17-canary-20240529133529

1 year ago

2.0.17-canary-20240531100307

1 year ago

2.0.17-canary-20240528095329

1 year ago

2.0.18-canary-20240606122557

1 year ago

2.0.16

1 year ago

2.0.17-canary-20240528103401

1 year ago

2.0.23-canary-20240726144557

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2.0.17-canary-20240529100235

1 year ago

2.0.20-canary-20240627203626

1 year ago

2.0.19-canary-20240608141031

1 year ago

2.0.17-canary-20240530140846

1 year ago

2.0.23-canary-20240726141312

1 year ago

2.0.17-canary-20240529135628

1 year ago

2.0.23-canary-20240729155900

1 year ago

2.0.17-canary-20240530085009

1 year ago

2.0.23-canary-20240726145935

1 year ago

2.0.17-canary-20240530144310

1 year ago

2.0.17-canary-20240529135035

1 year ago

2.0.17-canary-20240530145651

1 year ago

2.0.17-canary-20240530142029

1 year ago

2.0.15

1 year ago

2.0.14

1 year ago

2.0.13

1 year ago

2.0.13-canary-20240422130728

1 year ago

2.0.12

1 year ago

2.0.13-canary-20240422134554

1 year ago

2.0.13-canary-20240422140218

1 year ago

2.0.13-canary-20240422133146

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2.0.8-canary-20240325123729

1 year ago

2.0.8-canary-20240325133956

1 year ago

2.0.7-canary-20240318121813

1 year ago

2.0.7

1 year ago

2.0.7-canary-20240318121319

1 year ago

2.0.6

2 years ago

2.0.5

2 years ago

2.0.4

2 years ago

2.0.4-canary-20240124140945

2 years ago

2.0.3

2 years ago

2.0.2

2 years ago

2.0.3-canary-20240123144046

2 years ago

2.0.4-canary-20240123163215

2 years ago

2.0.1

2 years ago

2.0.1-canary-20240115111711

2 years ago

2.0.1-canary-20240115103811

2 years ago

2.0.1-canary-20240115132426

2 years ago

2.0.0-canary-20240111154354

2 years ago

2.0.0

2 years ago

2.0.0-canary-20240111135608

2 years ago

1.0.12-canary-20240109143553

2 years ago

1.0.11

2 years ago

1.0.12

2 years ago

1.0.11-canary-20231218115033

2 years ago

1.0.11-canary-20231218121046

2 years ago

1.0.10-canary-20231213150657

2 years ago

1.0.10-canary-20231213145741

2 years ago

1.0.10-canary-20231213155725

2 years ago

1.0.10

2 years ago

1.0.10-canary-20231212174453

2 years ago

1.0.10-canary-20231212111301

2 years ago

1.0.10-canary-20231204175323

2 years ago

1.0.10-canary-20231204163406

2 years ago

1.0.10-canary-20231204140033

2 years ago

1.0.10-canary-20231204093232

2 years ago

1.0.9

2 years ago

1.0.8-canary-20231120134811

2 years ago

0.4.0-canary-20230908141250

2 years ago

1.0.8-canary-20231120102451

2 years ago

0.3.25-canary-20230815153449

2 years ago

1.0.3-canary-20230926142647

2 years ago

0.3.25-canary-20230815160510

2 years ago

1.0.3-canary-20230926090152

2 years ago

1.0.4-canary-20230927121230

2 years ago

1.0.3-canary-20230926143330

2 years ago

0.4.0-canary-20230908103849

2 years ago

0.3.29-canary-20230904165345

2 years ago

0.3.29-canary-20230901133610

2 years ago

1.0.4-canary-20230928150656

2 years ago

0.4.0-canary-20230908140543

2 years ago

0.4.0-canary-20230908102706

2 years ago

1.0.8-canary-20231120095410

2 years ago

1.0.3-canary-20230926145337

2 years ago

0.3.24-canary-20230727192537

2 years ago

0.4.0

2 years ago

1.0.2

2 years ago

1.0.8-canary-20231120111113

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.3.25-canary-20230815161013

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.8-canary-20231120132554

2 years ago

1.0.3

2 years ago

0.3.29-canary-20230905140428

2 years ago

0.3.29

2 years ago

1.0.8-canary-20231120102924

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1.0.5-canary-20231004183332

2 years ago

1.0.3-canary-20230926191413

2 years ago

0.4.0-canary-20230908105028

2 years ago

1.0.5-canary-20231005165922

2 years ago

0.3.25-canary-20230815154741

2 years ago

1.0.3-canary-20230926231759

2 years ago

1.0.5-canary-20231005192540

2 years ago

1.0.7-canary-20231117131346

2 years ago

0.3.29-canary-20230904130827

2 years ago

0.3.29-canary-20230904122539

2 years ago

1.0.0-canary-20230913100135

2 years ago

1.0.5-canary-20231009173938

2 years ago

0.3.29-canary-20230904124942

2 years ago

0.3.25-canary-20230815153917

2 years ago

1.0.2-canary-20230919152505

2 years ago

0.3.22-canary-20230627075118

2 years ago

0.3.22-canary-20230627080114

2 years ago

0.3.22-canary-20230627093911

2 years ago

0.3.22

2 years ago

0.3.21

2 years ago

0.3.21-741-merge-20230623121144

2 years ago

0.3.21-741-merge-20230623102525

2 years ago

0.0.0-741-merge-20230623095300

2 years ago

0.0.0-741-merge-20230623094210

2 years ago

0.0.0-feat-markdown-provider-20230623141531

2 years ago

0.3.21-canary-20230623123632

2 years ago

0.3.21-canary-20230623124755

2 years ago

0.3.21-canary-20230623121641

2 years ago

0.3.21-741-merge-20230623103259

2 years ago

0.3.21-canary-20230623134212

2 years ago

0.3.21-canary-20230623133923

2 years ago

0.3.21-741-merge-20230623120013

2 years ago

0.0.0-741-merge-20230623100057

2 years ago

0.0.0-741-merge-20230623101705

2 years ago

0.3.21-canary-20230623130526

2 years ago

0.0.0-fix-dependencies-20230622092732

2 years ago

0.0.0-feat-markdown-provider-20230622155758

2 years ago

0.0.0-COM-1276-20230613001552

2 years ago

0.3.20

2 years ago

0.0.0-feat-markdown-provider-20230622161535

2 years ago

0.3.19

2 years ago

0.0.0-feat-markdown-provider-20230622150839

2 years ago

0.0.0-feat-markdown-provider-20230620220537

2 years ago

0.0.0-COM-1292-export-list-item-props-20230607070336

2 years ago

0.0.0-COM-1180-add-story-20230612084543

2 years ago

0.0.0-fix-dependencies-20230622091505

2 years ago

0.0.0-COM-1293-export-input-ref-20230609135825

2 years ago

0.0.0-COM-1294-export-checkbox-ref-20230609133537

2 years ago

0.0.0-COM-1292-li-styling-20230607075719

2 years ago

0.0.0-feat-markdown-provider-20230622143520

2 years ago

0.0.0-COM-1276-20230622093236

2 years ago

0.0.0-feat-markdown-provider-20230621205045

2 years ago

0.0.0-responsive-props-button-20230515123907

2 years ago

0.0.0-COM-1279-markdown-fixes-20230602092928

2 years ago

0.0.0-responsive-props-button-20230515122652

2 years ago

0.0.0-COM-1260-link-accent-variant-20230509175547

2 years ago

0.0.0-COM-1265-update-ts-chakra-20230517094036

2 years ago

0.0.0-COM-1104-add-new-colors-20230509125652

2 years ago

0.0.0-COM-1278-add-ordered-list-20230601152827

2 years ago

0.0.0-feat-static-replicas-20230519170326

2 years ago

0.0.0-COM-1265-update-ts-chakra-20230517090942

2 years ago

0.0.0-COM-1260-link-accent-variant-20230510091244

2 years ago

0.3.18

2 years ago

0.0.0-add-link-secondary-20230511122534

2 years ago

0.0.0-COM-1279-markdown-fixes-20230601164449

2 years ago

0.0.0-feat-replica-meta-20230509190059

2 years ago

0.0.0-fix-markdown-lists-20230526200922

2 years ago

0.0.0-COM-1265-update-ts-chakra-20230517074945

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-feat-replica-meta-20230509180356

2 years ago

0.3.13

2 years ago

0.0.0-fix-markdown-lists-20230524153658

2 years ago

0.0.0-COM-1260-link-accent-variant-20230510125320

2 years ago

0.0.0-COM-1260-link-accent-variant-20230509174838

2 years ago

0.0.0-COM-1104-add-new-colors-20230509125123

2 years ago

0.0.0-COM-1260-link-accent-variant-20230510085949

2 years ago

0.0.0-COM-1265-update-ts-chakra-20230517125150

2 years ago

0.0.0-HAM-62-carousel-component-20230426091319

2 years ago

0.0.0-spike-page-models-20230421161641

2 years ago

0.0.0-HAM-65-carousel-block-20230428130428

2 years ago

0.0.0-HAM-65-carousel-block-20230427160005

2 years ago

0.0.0-spike-page-models-20230420040125

2 years ago

0.3.12

2 years ago

0.0.0-HAM-62-carousel-component-20230425171353

2 years ago

0.0.0-spike-page-models-20230418160155

2 years ago

0.0.0-spike-page-models-20230418163345

2 years ago

0.0.0-spike-page-models-20230418164216

2 years ago

0.0.0-spike-page-models-20230421164439

2 years ago

0.0.0-HAM-65-carousel-block-20230427160557

2 years ago

0.0.0-spike-page-models-20230424162507

2 years ago

0.0.0-HAM-62-carousel-component-20230426092018

2 years ago

0.0.0-spike-page-models-20230424163753

2 years ago

0.0.0-spike-page-models-20230424164406

2 years ago

0.0.0-HAM-62-carousel-component-20230426130532

2 years ago

0.0.0-spike-page-models-20230419153508

2 years ago

0.0.0-spike-page-models-20230418141025

2 years ago

0.0.0-spike-page-models-20230419152334

2 years ago

0.0.0-spike-page-models-20230228181233

2 years ago

0.0.0-spike-page-models-20230302154308

2 years ago

0.0.0-20230228171841

2 years ago

0.3.11

2 years ago

0.0.0-spike-page-models-20230228191433

2 years ago

0.0.0-spike-page-models-20230228185714

2 years ago

0.0.0-spike-page-models-20230228192028

2 years ago

0.0.0-spike-page-models-20230228195749

2 years ago

0.0.0-spike-page-models-20230228190428

2 years ago

0.0.0-spike-page-models-20230301194008

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago