sulla

Sylla

Sulla est une bibliothèque javascript qui fournit un contrôle API de haut niveau à Whatsapp afin qu'elle puisse être configurée pour automatiser les réponses ou toute donnée transitant par Whatsapp sans effort.

Il est construit à l'aide du marionnettiste

État de Sulla

Depuis la version 2.3.5 il semble que sulla ait atteint une fonctionnalité et une architecture très riches et stables. Même si j'aimerais le faire, je ne peux pas consacrer beaucoup de temps à ce projet, alors pensez à consulter les versions forkées de sulla où d'autres développeurs peuvent y consacrer plus de temps et de support.

Projets basés sur Sulla activement soutenus recommandés :

venin

wppconnect

ouvrir-wa/wa-automate

Installation

 > npm i sulla --save

Commencer

 // 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!' ) ;
    }
  } ) ;
} 

Après avoir exécuté la fonction create() , sulla créera une instance de WhatsApp Web. Si vous n'êtes pas connecté, un code QR sera imprimé dans le terminal. Scannez-le avec votre téléphone et vous êtes prêt à partir !

Sulla se souviendra de la session, il n'est donc pas nécessaire de s'authentifier à chaque fois.

Plusieurs sessions peuvent être créées en même temps en passant un nom de session à la fonction create() :

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

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

Paramètres de création facultatifs

Le troisième paramètre de la méthode Sulla create() peut avoir les paramètres facultatifs suivants :

 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
} ) ; 

La définition du type peut être trouvée ici : CreateConfig.ts

Exporter le code QR

Par défaut, le code QR apparaîtra sur le terminal. Si vous devez transmettre le QR ailleurs, voici comment :

 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 ) ;
} 

Téléchargement de fichiers

Puppeteer s'occupe du téléchargement des fichiers. Le décryptage est effectué le plus rapidement possible (dépassant les méthodes natives). Prend en charge les gros fichiers !

 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 ) {
      ...
    } ) ;
  }
} ) ; 

Fonctions de base (utilisation)

Toutes les fonctions disponibles ne sont pas répertoriées. Pour une analyse plus approfondie, toutes les fonctions disponibles peuvent être trouvées ici et ici.

Bavardage

Ici, chatId pourrait être @c.us ou [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 ) ;

Récupération de données

 // 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 ) ;

Fonctions de groupe

 // 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 ) ;

Fonctions de profil

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

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

Fonctions de l'appareil

 // 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 ( ) ;

Événements

 // 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 => {
  ...
} ) ;

Autre

 // 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]' ) ; 

Divers

Il existe quelques astuces pour une meilleure utilisation de sulla.

Maintenir la session en vie :

 // 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 ( ) ;
  }
} ) ; 

Envoyer un message aux nouveaux contacts (non ajoutés)

Voir également les liens Whatsapp. Soyez prudent car cela peut entraîner une interdiction de Whatsapp, gardez toujours vos contacts à jour !

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

Plusieurs séances

Si vous devez exécuter plusieurs sessions à la fois, transmettez simplement un nom de session à la méthode create() .

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

Fermeture (sauvegarde) des sessions

Fermez correctement la session pour vous assurer qu'elle est enregistrée pour la prochaine fois que vous vous connecterez (elle ne demandera donc plus de scan QR). Donc au lieu de CTRL+C,

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

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

Débogage

Développement

Construire Sulla est vraiment simple même s'il contient 3 projets principaux à l'intérieur

1. Projet Wapi

 > npm run build:wapi

2. Intergiciel

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

3. Sylla

 > npm run build:sulla

Pour construire l'intégralité du projet, exécutez simplement

 > npm run build

Mainteneurs

Des responsables sont nécessaires, je ne peux pas suivre toutes les mises à jour par moi-même. Si vous êtes intéressé, veuillez ouvrir une Pull Request.

Contribuer

Les demandes de tirage sont les bienvenues. Pour les changements majeurs, veuillez d'abord ouvrir un ticket pour discuter de ce que vous souhaitez changer.