sulla

苏拉

Sulla 是一个 JavaScript 库，它为 Whatsapp 提供高级 API 控制，因此可以将其配置为自动化响应或轻松通过 Whatsapp 的任何数据。

它是使用 puppeteer 构建的

苏拉州

从2.3.5版本开始，sulla 似乎已经达到了非常丰富和稳定的功能和架构。尽管我很乐意，但我无法在这个项目上投入大量时间，因此请考虑查看 sulla 的分叉版本，其他开发人员可以在其中投入更多时间和支持。

推荐积极支持的基于苏拉的项目：

毒液

wpp连接

开放 wa/wa 自动化

安装

 > npm i sulla --save

入门

 // Supports ES6
// import { create, Whatsapp } from 'sulla';
const sulla = require ( 'sulla' ) ;

sulla . create ( ) . then ( ( client ) => start ( client ) ) ;

function start ( client ) {
  client . onMessage ( ( message ) => {
    if ( message . body === 'Hi' ) {
      client . sendText ( message . from , ' Hello from sulla!' ) ;
    }
  } ) ;
} 

执行create()函数后， sulla将创建一个whatsapp web实例。如果您尚未登录，它将在终端中打印二维码。用手机扫描一下，就可以出发了！

Sulla 会记住该会话，因此无需每次都进行身份验证。

通过将会话名称传递给create()函数，可以同时创建多个会话：

 // Init sales whatsapp bot
sulla . create ( 'sales' ) . then ( ( salesClient ) => { ... } ) ;

// Init support whatsapp bot
sulla . create ( 'support' ) . then ( ( supportClient ) => { ... } ) ; 

可选创建参数

Sulla create()方法的第三个参数可以有以下可选参数：

 create ( 'sessionName' , qrCallback , {
  headless : true , // Headless chrome
  devtools : false , // Open devtools by default
  useChrome : true , // If false will use Chromium instance
  debug : false , // Opens a debug session
  logQR : true // Logs QR automatically in terminal
  browserArgs : [ '' ] // Parameters to be added into the chrome browser instance
  refreshQR : 15000 , // Will refresh QR every 15 seconds, 0 will load QR once. Default is 30 seconds
} ) ; 

类型定义可以在这里找到：CreateConfig.ts

导出二维码

默认情况下，二维码将出现在终端上。如果您需要将二维码传递到其他地方，请按以下方式操作：

 const fs = require ( 'fs' ) ;

// Second create() parameter is the QR callback
sulla . create ( 'session-marketing' , ( base64Qr , asciiQR ) => {
  // To log the QR in the terminal
  console . log ( asciiQR ) ;

  // To write it somewhere else in a file
  exportQR ( base64Qr , 'marketing-qr.png' ) ;
} ) ;

// Writes QR in specified path
function exportQR ( qrCode , path ) {
  qrCode = qrCode . replace ( 'data:image/png;base64,' , '' ) ;
  const imageBuffer = Buffer . from ( qrCode , 'base64' ) ;

  // Creates 'marketing-qr.png' file
  fs . writeFileSync ( path , imageBuffer ) ;
} 

下载文件

Puppeteer 负责文件下载。解密正在尽可能快地完成（超过本机方法）。支持大文件！

 import fs = require ( 'fs' ) ;
import mime = require ( 'mime-types' ) ;

client . onMessage ( async ( message ) => {
  if ( message . isMedia ) {
    const buffer = await client . downloadFile ( message ) ;
    // At this point you can do whatever you want with the buffer
    // Most likely you want to write it into a file
    const fileName = `some-file-name. ${ mime . extension ( message . mimetype ) } ` ;
    fs . writeFile ( fileName , buffer , function ( err ) {
      ...
    } ) ;
  }
} ) ; 

基本功能（使用）

并未列出所有可用功能，为了进一步查看，每个可用功能都可以在此处和此处找到

聊天

此处， chatId可以是@c.us或[e-mail]

 // Send basic text
await client . sendText ( chatId , ' Hello from sulla!' ) ;

// Send image
await client . sendImage (
  chatId ,
  'path/to/img.jpg' ,
  'image-name.jpg' ,
  'Caption text'
) ;

// Send @tagged message
await client . sendMentioned ( chatId , 'Hello @5218113130740 and @5218243160777!' , [
  '5218113130740' ,
  '5218243160777' ,
] ) ;

// Reply to a message
await client . reply ( chatId , 'This is a reply!' , message . id . toString ( ) ) ;

// Send file (sulla will take care of mime types, just need the path)
await client . sendFile ( chatId , 'path/to/file.pdf' , 'cv.pdf' , 'Curriculum' ) ;

// Send gif
await client . sendVideoAsGif (
  chatId ,
  'path/to/video.mp4' ,
  'video.gif' ,
  'Gif image file'
) ;

// Send contact
// contactId: [email protected]
await client . sendContact ( chatId , contactId ) ;

// Forwards messages
await client . forwardMessages ( chatId , [ message . id . toString ( ) ] , true ) ;

// Send sticker
await client . sendImageAsSticker ( chatId , 'path/to/image.jpg' ) ;

// Send location
await client . sendLocation (
  chatId ,
  25.6801987 ,
  - 100.4060626 ,
  'Some address, Washington DC' ,
  'Subtitle'
) ;

// Send seen ✔️✔️
await client . sendSeen ( chatId ) ;

// Start typing...
await client . startTyping ( chatId ) ;

// Stop typing
await client . stopTyping ( chatId ) ;

// Set chat state (0: Typing, 1: Recording, 2: Paused)
await client . setChatState ( chatId , 0 | 1 | 2 ) ;

检索数据

 // Retrieve contacts
const contacts = await client . getAllContacts ( ) ;

// Retrieve all messages in chat
const allMessages = await client . loadAndGetAllMessagesInChat ( chatId ) ;

// Retrieve contact status
const status = await client . getStatus ( contactId ) ;

// Retrieve user profile
const user = await client . getNumberProfile ( contactId ) ;

// Retrieve all unread message
const messages = await client . getAllUnreadMessages ( ) ;

// Retrieve all chats
const chats = await client . getAllChats ( ) ;

// Retrieve all groups
const chats = await client . getAllGroups ( ) ;

// Retrieve profile fic (as url)
const url = await client . getProfilePicFromServer ( chatId ) ;

// Retrieve chat/conversation
const chat = await client . getChat ( chatId ) ;

集团职能

 // groupId or chatId: leaveGroup [email protected]

// Leave group
await client . leaveGroup ( groupId ) ;

// Get group members
await client . getGroupMembers ( groupId ) ;

// Get group members ids
await client . getGroupMembersIds ( groupId ) ;

// Generate group invite url link
await client . getGroupInviteLink ( groupId ) ;

// Create group (title, participants to add)
await client . createGroup ( 'Group name' , [ '[email protected]' , '[email protected]' ] ) ;

// Remove participant
await client . removeParticipant ( groupId , '[email protected]' ) ;

// Add participant
await client . addParticipant ( groupId , '[email protected]' ) ;

// Promote participant (Give admin privileges)
await client . promoteParticipant ( groupId , '[email protected]' ) ;

// Demote particiapnt (Revoke admin privileges)
await client . demoteParticipant ( groupId , '[email protected]' ) ;

// Get group admins
await client . getGroupAdmins ( groupId ) ;

配置文件功能

 // Set client status
await client . setProfileStatus ( 'On vacations! ✈️' ) ;

// Set client profile name
await client . setProfileName ( 'Sulla bot' ) ;

设备功能

 // Get device info
await client . getHostDevice ( ) ;

// Get connection state
await client . getConnectionState ( ) ;

// Get battery level
await client . getBatteryLevel ( ) ;

// Is connected
await client . isConnected ( ) ;

// Get whatsapp web version
await client . getWAVersion ( ) ;

活动

 // Listen to messages
client . onMessage ( message => {
  ...
} )

// Listen to state changes
client . onStateChange ( state => {
  ...
} ) ;

// Listen to ack's
client . onAck ( ack => {
  ...
} ) ;

// Listen to live location
// chatId: '[email protected]'
client . onLiveLocation ( chatId , ( liveLocation ) => {
  ...
} ) ;

// chatId looks like this: '[email protected]'
// Event interface is in here: https://github.com/danielcardeenas/sulla/blob/master/src/api/model/participant-event.ts
client . onParticipantsChanged ( chatId , ( event ) => {
  ...
} ) ;

// Listen when client has been added to a group
client . onAddedToGroup ( chatEvent => {
  ...
} ) ;

其他

 // Delete chat
await client . deleteChat ( chatId ) ;

// Clear chat messages
await client . clearChat ( chatId ) ;

// Delete message (last parameter: delete only locally)
await client . deleteMessage ( chatId , message . id . toString ( ) , false ) ;

// Retrieve a number profile / check if contact is a valid whatsapp number
const profile = await client . getNumberProfile ( '[email protected]' ) ; 

杂项

有一些技巧可以更好地使用苏拉。

保持会话存活：

 // In case of being logged out of whatsapp web
// Force it to keep the current session
// State change
client . onStateChange ( ( state ) => {
  console . log ( state ) ;
  const conflits = [
    sulla . SocketState . CONFLICT ,
    sulla . SocketState . UNPAIRED ,
    sulla . SocketState . UNLAUNCHED ,
  ] ;
  if ( conflits . includes ( state ) ) {
    client . useHere ( ) ;
  }
} ) ; 

向新联系人发送消息（未添加）

另请参阅 Whatsapp 链接 请小心，因为这很可能会导致 Whatsapp 被禁止，请始终保持您的联系人更新！

 await client . sendMessageToId ( '[email protected]' , 'Hello from sulla! ' ) ; 

多次会议

如果您需要一次运行多个会话，只需将会话名称传递给create()方法即可。

 async ( ) => {
  const marketingClient = await sulla . create ( 'marketing' ) ;
  const salesClient = await sulla . create ( 'sales' ) ;
  const supportClient = await sulla . create ( 'support' ) ;
} ; 

关闭（保存）会话

正确关闭会话以确保下次登录时保存会话（因此不会再次要求进行二维码扫描）。因此，不要使用 CTRL+C，

 // Catch ctrl+C
process . on ( 'SIGINT' , function ( ) {
  client . close ( ) ;
} ) ;

// Try-catch close
try {
   ...
} catch ( error ) {
   client . close ( ) ;
}

调试

发展

建造苏拉非常简单，尽管它包含 3 个主要项目

1. 瓦皮项目

 > npm run build:wapi

2. 中间件

 > npm run build:build:middleware
> npm run build:jsQR

3. 苏拉

 > npm run build:sulla

要构建整个项目，只需运行

 > npm run build

维护者

需要维护人员，我一个人无法跟上所有的更新。如果您有兴趣，请打开拉取请求。

贡献

欢迎请求请求。对于重大更改，请先打开一个问题来讨论您想要更改的内容。