npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cmpsr/twilio

v0.3.0

Published

[![npm version](https://img.shields.io/npm/v/@cmpsr/twilio.svg?style=flat-square)](https://www.npmjs.com/package/@cmpsr/twilio)

Downloads

145

Readme

@cmpsr/twilio

npm version

npm license

npm downloads

Wrapper over Twilio API

Features

  • Send sms using pre-registered numbers
  • Build conversations with virtual spaces

Installing

Using npm:

$ npm install @cmpsr/twilio

Using yarn:

$ yarn add @cmpsr/twilio

Examples

CommonJS usage

const { useTwilioSms, useTwilioConversation } = require("@cmpsr/twilio");

ES usage

import { useTwilioSms, useTwilioConversation } from "@cmpsr/twilio";

Sending a sms with ExpressJS

const express = require("express");
const { useTwilioSms } = require("@cmpsr/twilio");

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

const twilioSms = useTwilioSms();

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

Creating a conversation with ExpressJS

const express = require("express");
const { useTwilioConversation } = require("@cmpsr/twilio");

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

const twilioConversation = useTwilioConversation();

app.post("/", async (req, res) => {
  const {
    body: { friendlyName },
  } = req;
  const conversation = await twilioConversation.create(friendlyName);
  res.json(conversation);
});

API

useTwilioSms([, accountSid[, authToken[, serviceId]]])
const accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const authToken = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const serviceId = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

const twilioSms = useTwilioSms(accountSid, authToken, serviceId);
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
TWILIO_ACCOUNT_SID = ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_AUTH_TOKEN = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_CHAT_SERVICE_SID = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Now, load your variables using the dotenv package

require("dotenv").config();
const { useTwilioSms } = require("@cmpsr/twilio");
const twilioSms = useTwilioSms();
useTwilioConversation([, accountSid[, authToken[, serviceId]]])
const accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const authToken = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const serviceId = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

const twilioConversation = useTwilioConversation(
  accountSid,
  authToken,
  serviceId
);
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
TWILIO_ACCOUNT_SID = ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_AUTH_TOKEN = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_CHAT_SERVICE_SID = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Now, load your variables using the dotenv package

require("dotenv").config();
const { twilioConversation } = require("@cmpsr/twilio");
const twilioConversation = twilioConversation();

SMS Instance methods

The available instance methods are listed below.

twilioSms#send(message: string, from: string, to: string)
twilioSms#availablePhones(areaCode: number, country: string[, mmsEnabled: boolean[, smsEnabled: boolean[, limit: number]]])
twilioSms#buy(phoneNumber: string[, friendlyName: string[, smsUrl: string[, smsMethod: string]]])

Conversation Instance methods

twilioConversation#create(friendlyName: string)
twilioConversation#getConversations()
twilioConversation#getConversation(sid: string)
twilioConversation#addSmsParticipant(conversationSid: string, invitedPhone: string, inviterPhone: string)
twilioConversation#addParticipant(conversationSid: string, identity: string)
twilioConversation#sendMessage(conversationSid: string, author: string, body: string[, attributes: string])
twilioConversation#getMessages(conversationSid: string)
twilioConversation#addConversationWebhook(conversationSid: string, webhook: string[, method: 'GET' | 'POST' ])
twilioConversation#getMedia(mediaId: string)

Resources

License

MIT