piwapi-service
v1.0.1
Published
PiwapiService is a Node.js library that allows you to send WhatsApp messages using the Piwapi service.
Downloads
2
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 is2
.”
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);
}