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

piwapi-service

v1.0.1

Published

PiwapiService is a Node.js library that allows you to send WhatsApp messages using the Piwapi service.

Downloads

14

Readme

PiwapiService

PiwapiService is a Node.js library that allows you to send WhatsApp messages using the Piwapi service.

Installation

You can install this package via npm:

npm install piwapi-service

Usage

Usage Basic

Here is a basic example of how to use the PiwapiService to send a WhatsApp message:

const PiwapiService = require("piwapi-service");

const piwapi = new PiwapiService({
    apiKey: process.env.PIWAPI_API_KEY,
    deviceId: process.env.PIWAPI_DEVICE_ID,
});

// Sending a media message
piwapi.sendWhatsappSingleMessage({
    recipient: '082129632854',
    message: 'Check out this image!',
    type: 'media',
    media_url: 'https://domain.com/image.jpg',
    media_type: 'image',
}).then(response => {
    console.log('Media message sent:', response);
}).catch(error => {
    console.error('Error:', error);
});

// Sending a document message
piwapi.sendWhatsappSingleMessage({
    recipient: '082129632854',
    message: 'Hello ',
    type: 'document',
    document_url: 'https://domain.com/file.pdf',
    document_name: 'tugas.pdf',
    document_type: 'pdf',
}).then(response => {
    console.log('Document message sent:', response);
}).catch(error => {
    console.error('Error:', error);
});

Parameters

  • apiKey: Your API key from Piwapi.
  • deviceId: The device ID associated with your Piwapi account.
  • recipient: The recipient's phone number. If it starts with '0', the package will automatically convert it to the appropriate format (e.g., '62' for Indonesia). * message: The message you want to send.
  • type (optional): The type of message. Default is "text". Allowed values are "text", "media", and "document".
  • priority (optional): The priority of the message. 1 for high priority, 2 for normal priority. Default is 2.”

Response Handling

The method sendWhatsappSingleMessage returns a promise that resolves with the response data from Piwapi or rejects with an error if the request fails.

Environment Variables

You can store sensitive data in environment variables to keep your code secure. Here's an example of the environment variables you might need:

PIWAPI_API_KEY=your_api_key_here
PIWAPI_DEVICE_ID=your_device_id_here

Error Handling

Ensure you wrap your calls in try/catch blocks or use .catch() to handle any potential errors.

try {
    const response = await service.sendMessage(params);
    console.log('Message sent:', response);
} catch (error) {
    console.error('Failed to send message:', error);
}

#Rendi Julianto