npm-whatsapp-api介绍

简介

npm-whatsapp-api是一款基于Node.js的WhatsApp API库，可以通过该库实现用JavaScript语言来实现自动化发送和接收消息。

安装

使用npm安装：

npm install npm-whatsapp-api --save

示例

下面是一个快速上手的示例，展示如何通过npm-whatsapp-api来实现消息的自动回复：

const Whatsapp = require('npm-whatsapp-api');

const client = new Whatsapp({
    phoneNumber: 'your phone number with the country code',
    clientName: 'your client name',
    clientToken: 'your client token',
    logger: false,
    takeoverOnConflict: true
});

client.on('qrCode', (qrCode) => {
    console.log(`Please scan the QR code to log in: ${qrCode}`);
});

client.on('ready', () => {
    console.log('Client is ready!');
});

client.on('message', async (message) => {
    if (message.body === '/hello') {
        await client.sendMessage(message.from, 'Hi there!');
    }
});

client.initialize();

API

npm-whatsapp-api库提供了以下API：

new Whatsapp(options: object)

创建一个whatsapp客户端并返回，需要传入的参数如下：

• phoneNumber: 必选参数，表示您的WhatsApp号码，以国家代码开头，比如'+86123456789'；
• clientName: 必选参数，表示客户端名称；
• clientToken: 必选参数，表示客户端令牌；
• logger: 可选参数，表示是否启用日志，默认为true；
• takeoverOnConflict: 可选参数，当客户端登录被替代时，是否自动接替，默认为false。

client.initialize()

初始化客户端并登录WhatsApp。

client.sendTextMessage(to: string, text: string)

向指定的联系人发送文本消息。

client.sendMessage(to: string, content: string|Message)

向指定的联系人发送消息，可以是文本消息或者Message对象。

client.on(event: string, listener: (...args: any[]) => void)

注册事件监听器，支持以下事件：

• qrCode: 当需要扫描二维码进行登录时触发；
• ready：客户端已初始化，并已登录；
• message：收到新消息时触发，参数为Message对象。

注意事项

注意，使用npm-whatsapp-api库需要获取WhatsApp的API密钥，在未经允许情况下使用WhatsApp的API是不被允许的。

结论

npm-whatsapp-api是一个强大的Node.js库，允许我们使用JavaScript来自动化WhatsApp消息的发送和接收，这为各种场景下的自动化消息处理提供了便利。 需要注意的是，使用此库需要申请WhatsApp的API密钥，且未经允许情况下使用WhatsApp的API是违法的。