venom
v5.3.0
Venom ist ein Hochleistungssystem, das mit JavaScript entwickelt wurde, um einen Bot für WhatsApp zu erstellen, Unterstützung für die Erstellung von Interaktion, z. B. Kundenservice, Mediensenden, Satzerkennung auf der Grundlage künstlicher Intelligenz und aller Arten von Designarchitektur für WhatsApp.
Vollständige Dokumentation
Es handelt sich um eine hochleistungsfähige alternative API für WhatsApp. Sie können Textnachrichten, Dateien, Bilder, Videos und mehr senden.
Denken Sie daran, dass die API auf einer Plattform namens Rastful Web Services entwickelt wurde und die Interoperabilität zwischen Computersystemen im Internet bietet.
Es verwendet eine Reihe gut definierter Vorgänge, die für alle Informationsressourcen gelten: HTTP selbst definiert eine kleine Reihe von Vorgängen, wobei das wichtigste Beitrag, Get, Put und Löschen ist.
Verwenden Sie es in Ihrer Lieblingssprache wie PHP, Python, C# und anderen. Solange Ihre Sprache mit dem HTTP -Protokoll unterstützt wird, sparen Sie Zeit und Geld. Sie müssen nicht wissen, wie Venom funktioniert, wir haben die vollständige API -Dokumentation auf professionelle Weise!
Superchats ist eine Premium -Bibliothek mit einzigartigen Funktionen, die WhatsApp -Funktionen mit Socket steuern. Mit Superchats können Sie Service -Bots, Multiservice -Chats oder jedes System erstellen, das WhatsApp verwendet
Superchats ist eine Premium -Version von Venom mit exklusiven Funktionen und Unterstützung für Unternehmen und Entwickler weltweit
https://github.com/orkestral/superchats
Der Wert der Lizenz beträgt monatlich 50 US -Dollar, um Kontakt in WhatsApp zu erwerben, indem Sie auf das Bild unten klicken !!
| ? Automatische QR -Aktualisierung | ✔ |
| ? Senden Sie Text, Bild, Video, Audio und Dokumente | ✔ |
| Holen Sie sich Kontakte, Chats, Gruppen, Gruppenmitglieder, Blockliste | ✔ |
| ? Kontakte senden | ✔ |
| Schaltflächen senden | ✔ |
| Aufkleber senden | ✔ |
| Senden Sie Aufkleber GIF | ✔ |
| Mehrere Sitzungen | ✔ |
| ⏩ Nachrichten weiterleiten | ✔ |
| ? Nachricht erhalten | ✔ |
| ? Benutzerabschnitt einfügen | ✔ |
| ? Standort senden !! | ✔ |
| ? und noch viel mehr | ✔ |
Dokumentation unter https://orkestral.github.io/venom/index.html
> npm i --save venom-botoder für nächtliche Veröffentlichungen:
> npm i --save https://github.com/orkestral/venom/releases/download/nightly/venom-bot-nightly.tgzInstallieren des aktuellen Repositorys "Sie können die Beta -Version aus dem aktuellen Repository herunterladen!"
> npm i github:orkestral/venom // Supports ES6
// import { create, Whatsapp } from 'venom-bot';
const venom = require ( 'venom-bot' ) ;
venom
. create ( {
session : 'session-name' //name of session
} )
. then ( ( client ) => start ( client ) )
. catch ( ( erro ) => {
console . log ( erro ) ;
} ) ;
function start ( client ) {
client . onMessage ( ( message ) => {
if ( message . body === 'Hi' && message . isGroupMsg === false ) {
client
. sendText ( message . from , 'Welcome Venom ?' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
}
} ) ;
} create() -Funktion erstellt Venom eine Instanz von WhatsApp -Web. Wenn Sie nicht angemeldet sind, drucken Sie einen QR -Code im Terminal. Scannen Sie es mit Ihrem Telefon und Sie sind bereit zu gehen! create() -Funktion erstellt wird: // Init sales whatsapp bot
venom . create ( 'sales' ) . then ( ( salesClient ) => { ... } ) ;
// Init support whatsapp bot
venom . create ( 'support' ) . then ( ( supportClient ) => { ... } ) ; Venom create() Methode Der dritte Parameter kann die folgenden optionalen Parameter haben:
--user-agent Sie den Linux -Server verwenden
const venom = require ( 'venom-bot' ) ;
venom
. create (
//session
'sessionName' , //Pass the name of the client you want to start the bot
//catchQR
( base64Qrimg , asciiQR , attempts , urlCode ) => {
console . log ( 'Number of attempts to read the qrcode: ' , attempts ) ;
console . log ( 'Terminal qrcode: ' , asciiQR ) ;
console . log ( 'base64 image string qrcode: ' , base64Qrimg ) ;
console . log ( 'urlCode (data-ref): ' , urlCode ) ;
} ,
// statusFind
( statusSession , session ) => {
console . log ( 'Status Session: ' , statusSession ) ; //return isLogged || notLogged || browserClose || qrReadSuccess || qrReadFail || autocloseCalled || desconnectedMobile || deleteToken || chatsAvailable || deviceNotConnected || serverWssNotConnected || noOpenBrowser || initBrowser || openBrowser || connectBrowserWs || initWhatsapp || erroPageWhatsapp || successPageWhatsapp || waitForLogin || waitChat || successChat
//Create session wss return "serverClose" case server for close
console . log ( 'Session name: ' , session ) ;
} ,
// options
{
browserPathExecutable : '' , // browser executable path
folderNameToken : 'tokens' , //folder name when saving tokens
mkdirFolderToken : '' , //folder directory tokens, just inside the venom folder, example: { mkdirFolderToken: '/node_modules', } //will save the tokens folder in the node_modules directory
headless : 'new' , // you should no longer use boolean false or true, now use false, true or 'new' learn more https://developer.chrome.com/articles/new-headless/
devtools : false , // Open devtools by default
debug : false , // Opens a debug session
logQR : true , // Logs QR automatically in terminal
browserWS : '' , // If u want to use browserWSEndpoint
browserArgs : [ '' ] , // Original parameters ---Parameters to be added into the chrome browser instance
addBrowserArgs : [ '' ] , // Add broserArgs without overwriting the project's original
puppeteerOptions : { } , // Will be passed to puppeteer.launch
disableSpins : true , // Will disable Spinnies animation, useful for containers (docker) for a better log
disableWelcome : true , // Will disable the welcoming message which appears in the beginning
updatesLog : true , // Logs info updates automatically in terminal
autoClose : 60000 , // Automatically closes the venom-bot only when scanning the QR code (default 60 seconds, if you want to turn it off, assign 0 or false)
createPathFileToken : false , // creates a folder when inserting an object in the client's browser, to work it is necessary to pass the parameters in the function create browserSessionToken
addProxy : [ '' ] , // Add proxy server exemple : [e1.p.webshare.io:01, e1.p.webshare.io:01]
userProxy : '' , // Proxy login username
userPass : '' // Proxy password
} ,
// BrowserInstance
( browser , waPage ) => {
console . log ( 'Browser PID:' , browser . process ( ) . pid ) ;
waPage . screenshot ( { path : 'screenshot.png' } ) ;
}
)
. then ( ( client ) => {
start ( client ) ;
} )
. catch ( ( erro ) => {
console . log ( erro ) ;
} ) ; autocloseCalled deviceNotConnected chatsAvailable qrReadFail initBrowser deleteToken serverWssNotConnected isLogged noOpenBrowser notLogged qrReadSuccess desconnectedMobile browserClose openBrowser connectBrowserWs initWhatsapp erroPageWhatsapp oder successPageWhatsapp oder waitForLogin oder waitChat oder successChat oder Create session wss return "serverClose" case server for close
| Status | Zustand |
|---|---|
isLogged | Wenn der Benutzer bereits im Browser angemeldet ist |
notLogged | Wenn der Benutzer nicht mit dem Browser verbunden ist, muss der QR -Code im Handy in der Option WhatsApp -Web über das Handy gescannt werden |
browserClose | Wenn der Browser geschlossen ist, wird dieser Parameter zurückgegeben |
qrReadSuccess | Wenn der Benutzer nicht angemeldet ist, wird der QR -Code an dem Terminal weitergegeben. Ein Rückruf wird zurückgegeben. Nach dem richtigen Lesen per Handy wird dieser Parameter zurückgegeben |
qrReadFail | Wenn der Browser beim Ablauf des QR -Code -Scans anhält, wird dieser Parameter zurückgegeben |
autocloseCalled | Der Browser wurde mit dem AutoClose -Befehl geschlossen |
desconnectedMobile | Der Kunde hat sich in das Handy angeschlossen |
serverClose | Der Kunde hat sich in WSS angeschlossen |
deleteToken | Wenn Sie in der Funktion true bestehen |
chatsAvailable | Wenn Venom mit der Chat -Liste verbunden ist |
deviceNotConnected | Chat nicht verfügbar, weil das Telefon getrennt ist (Trying to connect to the phone) |
serverWssNotConnected | Die Adresse WSS wurde nicht gefunden! |
noOpenBrowser | Es wurde nicht im Browser gefunden, oder ein Befehl fehlt in Args |
initBrowser | Den Browser starten |
openBrowser | Der Browser wurde erfolgreich eröffnet! |
connectBrowserWs | Verbindung mit BrowserWs erfolgreich gemacht! |
initWhatsapp | WhatsApp starten! |
erroPageWhatsapp | Fehler zugreifen auf WhatsApp -Seite |
successPageWhatsapp | Seite WhatsApp erfolgreich zugegriffen |
waitForLogin | Warten auf die Anmeldeverifizierung! |
waitChat | Warten auf das Laden des Chats |
successChat | Chat erfolgreich geladen! |
const venom = require ( 'venom-bot' ) ;
venom
. create ( 'sessionName' , undefined , ( statusSession , session ) => {
console . log ( 'Status Session: ' , statusSession ) ;
//return isLogged || notLogged || browserClose || qrReadSuccess || qrReadFail || autocloseCalled || desconnectedMobile || deleteToken || chatsAvailable || deviceNotConnected || serverWssNotConnected || noOpenBrowser || initBrowser || openBrowser || connectBrowserWs || initWhatsapp || erroPageWhatsapp || successPageWhatsapp || waitForLogin || waitChat || successChat
//Create session wss return "serverClose" case server for close
console . log ( 'Session name: ' , session ) ;
} )
. then ( ( client ) => {
start ( client ) ;
} )
. catch ( ( erro ) => {
console . log ( erro ) ;
} ) ; Standardmäßig wird QR -Code am Terminal angezeigt. Wenn Sie die QR an einem anderen Ort bestehen müssen, hier ist: wie:
const fs = require ( 'fs' ) ;
const venom = require ( 'venom-bot' ) ;
venom
. create (
'sessionName' ,
( base64Qr , asciiQR , attempts , urlCode ) => {
console . log ( asciiQR ) ; // Optional to log the QR in the terminal
var matches = base64Qr . match ( / ^data:([A-Za-z-+/]+);base64,(.+)$ / ) ,
response = { } ;
if ( matches . length !== 3 ) {
return new Error ( 'Invalid input string' ) ;
}
response . type = matches [ 1 ] ;
response . data = new Buffer . from ( matches [ 2 ] , 'base64' ) ;
var imageBuffer = response ;
require ( 'fs' ) . writeFile (
'out.png' ,
imageBuffer [ 'data' ] ,
'binary' ,
function ( err ) {
if ( err != null ) {
console . log ( err ) ;
}
}
) ;
} ,
undefined ,
{ logQR : false }
)
. then ( ( client ) => {
start ( client ) ;
} )
. catch ( ( erro ) => {
console . log ( erro ) ;
} ) ; Puppeteeder kümmert sich um das Herunterladen der Datei. Die Entschlüsselung wird so schnell wie möglich durchgeführt (übereinstimmende native Methoden). Unterstützt große Dateien!
import fs = require ( 'fs' ) ;
import mime = require ( 'mime-types' ) ;
client . onMessage ( async ( message ) => {
if ( message . isMedia === true || message . isMMS === true ) {
const buffer = await client . decryptFile ( 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 , ( err ) => {
...
} ) ;
}
} ) ; Nicht jede verfügbare Funktion ist aufgelistet. Für weitere Aussehen finden Sie jede verfügbare Funktion hier und hier
chatId <phoneNumber>@c.us oder <phoneNumber>-<groupId>@g.us sein // Send Poll
const poll = {
name : 'new poll' ,
options : [
{
name : 'option 1'
} ,
{
name : 'option 2'
}
] ,
selectableOptionsCount : 1
} ;
await client . sendPollCreation ( '[email protected]' , poll )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send List menu
const list = [
{
title : "Pasta" ,
rows : [
{
title : "Ravioli Lasagna" ,
description : "Made with layers of frozen cheese" ,
}
]
} ,
{
title : "Dessert" ,
rows : [
{
title : "Baked Ricotta Cake" ,
description : "Sweets pecan baklava rolls" ,
} ,
{
title : "Lemon Meringue Pie" ,
description : "Pastry filled with lemonand meringue." ,
}
]
}
] ;
await client . sendListMenu ( '[email protected]' , 'Title' , 'subTitle' , 'Description' , 'menu' , list )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send Messages with Buttons Reply
const buttons = [
{
"buttonText" : {
"displayText" : "Text of Button 1"
}
} ,
{
"buttonText" : {
"displayText" : "Text of Button 2"
}
}
]
await client . sendButtons ( '[email protected]' , 'Title' , 'Description' , buttons )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send audio file MP3
await client . sendVoice ( '[email protected]' , './audio.mp3' ) . then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send audio file base64
await client . sendVoiceBase64 ( '[email protected]' , base64MP3 )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send contact
await client
. sendContactVcard ( '[email protected]' , '[email protected]' , 'Name of contact' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send a list of contact cards
await client
. sendContactVcardList ( '[email protected]' , [
'[email protected]' ,
'[email protected]' ,
] )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send basic text
await client
. sendText ( '[email protected]' , ' Hello from venom!' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send text message by injecting keystrokes into WhatsApp, thus maintaining the typing indicator
let success = await client . sendTextViaTyping ( '[email protected]' , ' Hello from venom!' ) ;
// Send photo or video by injecting keystrokes
let success = await client . sendPhotoVideoViaTyping ( '[email protected]' , 'path/to/file.jpg' , 'Pretty sunset' ) ;
// Send location
await client
. sendLocation ( '[email protected]' , '-13.6561589' , '-69.7309264' , 'Brasil' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Automatically sends a link with the auto generated link preview. You can also add a custom message to be added.
await client
. sendLinkPreview (
'[email protected]' ,
'https://www.youtube.com/watch?v=V1bFr2SWP1I' ,
'Kamakawiwo ole'
)
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send image (you can also upload an image using a valid HTTP protocol)
await client
. sendImage (
'[email protected]' ,
'path/to/img.jpg' ,
'image-name' ,
'Caption text'
)
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send image file base64
await client . sendImageFromBase64 ( '[email protected]' , base64Image , "name file" )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send file (venom will take care of mime types, just need the path)
// you can also upload an image using a valid HTTP protocol
await client
. sendFile (
'[email protected]' ,
'path/to/file.pdf' ,
'file_name' ,
'See my file in pdf'
)
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Sends file
// base64 parameter should have mime type already defined
await client
. sendFileFromBase64 (
'[email protected]' ,
base64PDF ,
'file_name.pdf' ,
'See my file in pdf'
)
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Generates sticker from the provided animated gif image and sends it (Send image as animated sticker)
// image path imageBase64 A valid gif and webp image is required. You can also send via http/https (http://www.website.com/img.gif)
await client
. sendImageAsStickerGif ( '[email protected]' , './image.gif' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Generates sticker from given image and sends it (Send Image As Sticker)
// image path imageBase64 A valid png, jpg and webp image is required. You can also send via http/https (http://www.website.com/img.jpg)
await client
. sendImageAsSticker ( '[email protected]' , './image.jpg' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Forwards messages
await client . forwardMessages (
'[email protected]' ,
[ '[email protected]_B70847EE89E22D20FB86ECA0C1B11609' , '[email protected]_B70847EE89E22D20FB86ECA0C1B11777' ]
) . then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send @tagged message
await client . sendMentioned (
'[email protected]' ,
'Hello @5218113130740 and @5218243160777!' ,
[ '5218113130740' , '5218243160777' ]
) ;
// Reply to a message
await client . reply (
'[email protected]' ,
'This is a reply!' ,
'[email protected]_7C22WHCB6DKYHJKQIEN9'
) . then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} ) . catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Send message with options
await client .
. sendMessageOptions (
'[email protected]' ,
'This is a reply!' ,
{
quotedMessageId : reply ,
}
)
. then ( ( retorno ) => {
resp = retorno ;
} )
. catch ( ( e ) => {
console . log ( e ) ;
} ) ;
// Send gif
await client . sendVideoAsGif (
'[email protected]' ,
'path/to/video.mp4' ,
'video.gif' ,
'Gif image file'
) ;
//checks and returns whether a message and a reply
// exemple:
// await client.onMessage(async (message) => {
// console.log(await client.returnReply(message)); // replicated message
// console.log(message.body ); //customer message
// })
checkReply = await client . returnReply ( messagem ) ;
// Send seen ✔️✔️
await client . sendSeen ( '[email protected]' ) ;
// Start typing...
await client . startTyping ( '[email protected]' ) ;
// Set chat state (0: Typing, 1: Recording, 2: Paused)
await client . setChatState ( '[email protected]' , 0 | 1 | 2 ) ; // Retrieve all chats
const chats = await client . getAllChats ( ) ;
//Retrieves all chats new messages
const chatsAllNew = getAllChatsNewMsg ( ) ;
//Retrieves all chats Contacts
const contacts = await client . getAllChatsContacts ( ) ;
//Retrieve all contacts new messages
const contactNewMsg = await client . getChatContactNewMsg ( ) ;
// Retrieve all groups
// you can pass the group id optional use, exemple: client.getAllChatsGroups('[email protected]')
const chats = await client . getAllChatsGroups ( ) ;
//Retrieve all groups new messages
const groupNewMsg = await client . getChatGroupNewMsg ( ) ;
//Retrieves all chats Transmission list
const transmission = await client . getAllChatsTransmission ( ) ;
// Retrieve contacts
const contacts = await client . getAllContacts ( ) ;
// Returns a list of mute and non-mute users
// "all" List all mutes
// "toMute" List all silent chats
// "noMute" List all chats without silence
const listMute = await client . getListMute ( 'all' ) ;
// Calls your list of blocked contacts (returns an array)
const getBlockList = await client . getBlockList ( ) ;
// Retrieve messages in chat
//chatID chat id
//includeMe will be by default true, if you do not want to pass false
//includeNotifications will be by default true, if you do not want to pass false
//const Messages = await client.getAllMessagesInChat(chatID, includeMe, includeNotifications)
const Messages = await client . getAllMessagesInChat ( '[email protected]' ) ;
// Retrieve more chat message
const moreMessages = await client . loadEarlierMessages ( '[email protected]' ) ;
// Retrieve all messages in chat
const allMessages = await client . loadAndGetAllMessagesInChat (
'[email protected]'
) ;
// Retrieve contact status
const status = await client . getStatus ( '[email protected]' ) ;
// Retrieve user profile
// Please note that this function does not currently work due to a bug in WhatsApp itself.
// There is no telling if or when this function might work again.
const user = await client . getNumberProfile ( '[email protected]' ) ;
// Retrieve all unread message
const messages = await client . getUnreadMessages ( ) ;
// Retrieve profile fic (as url)
const url = await client . getProfilePicFromServer ( '[email protected]' ) ;
// Retrieve chat/conversation
const chat = await client . getChat ( '[email protected]' ) ;
// Check if the number exists
const chat = await client
. checkNumberStatus ( '[email protected]' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ; // groupId or chatId: leaveGroup [email protected]
//change group description
await client
. setGroupDescription ( '[email protected]' , 'group description' )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Leave group
await client . leaveGroup ( '[email protected]' ) ;
// Get group members
await client . getGroupMembers ( '[email protected]' ) ;
// Get group members ids
await client . getGroupMembersIds ( '[email protected]' ) ;
// Generate group invite url link
await client . getGroupInviteLink ( '[email protected]' ) ;
// Create group (title, participants to add)
await client . createGroup ( 'Group name' , [
'[email protected]' ,
'[email protected]'
] ) ;
// Remove participant
await client . removeParticipant ( '[email protected]' , '[email protected]' ) ;
// Add participant
await client . addParticipant ( '[email protected]' , '[email protected]' ) ;
// Promote participant (Give admin privileges)
await client . promoteParticipant ( '[email protected]' , '[email protected]' ) ;
// Demote particiapnt (Revoke admin privileges)
await client . demoteParticipant ( '[email protected]' , '[email protected]' ) ;
// Get group admins
await client . getGroupAdmins ( '[email protected]' ) ;
// Return the group status, jid, description from it's invite link
await client . getGroupInfoFromInviteLink ( InviteCode ) ;
// Join a group using the group invite code
await client . joinGroup ( InviteCode ) ; // Set client status
await client . setProfileStatus ( 'On vacations! ✈️' ) ;
// Set client profile name
await client . setProfileName ( 'Venom bot' ) ;
// Set client profile photo
await client . setProfilePic ( 'path/to/image.jpg' ) ;
// Get device info
await client . getHostDevice ( ) ; // Disconnect from service
await client . logout ( ) ;
// Delete the Service Worker
await client . killServiceWorker ( ) ;
// Load the service again
await client . restartService ( ) ;
// Get connection state
await client . getConnectionState ( ) ;
// Get battery level
await client . getBatteryLevel ( ) ;
// Is connected
await client . isConnected ( ) ;
// Get whatsapp web version
await client . getWAVersion ( ) ; //Listens to all new messages
//To receiver or recipient
client . onAnyMessage ( message => {
...
} ;
// Listen to messages
client . onMessage ( message => {
...
} )
// Listen for messages that have been edited
client . onMessageEdit ( message => {
...
} )
// Listen for messages that have been deleted
client . onMessageDelete ( message => {
...
} )
// Listen to state changes
client . onStateChange ( state => {
...
} ) ;
// Listen to ack's
// See the status of the message when sent.
// When receiving the confirmation object, "ack" may return a number, look {@link AckType} for details:
// -7 = MD_DOWNGRADE,
// -6 = INACTIVE,
// -5 = CONTENT_UNUPLOADABLE,
// -4 = CONTENT_TOO_BIG,
// -3 = CONTENT_GONE,
// -2 = EXPIRED,
// -1 = FAILED,
// 0 = CLOCK,
// 1 = SENT,
// 2 = RECEIVED,
// 3 = READ,
// 4 = PLAYED =
client . onAck ( ack => {
...
} ) ;
// Listen to live location
// chatId: '[email protected]'
client . onLiveLocation ( "[email protected]" , ( liveLocation ) => {
...
} ) ;
// chatId looks like this: '[email protected]'
// Event interface is in here: https://github.com/s2click/venom/blob/master/src/api/model/participant-event.ts
client . onParticipantsChanged ( "[email protected]" , ( event ) => {
...
} ) ;
// Listen when client has been added to a group
client . onAddedToGroup ( chatEvent => {
...
} ) ; //Check if there is chat
await client
. checkChat ( chatId )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Pin chat and Unpin chat messages with true or false
// Pin chat, non-existent (optional)
await client
. pinChat ( chatId , true , false )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
///mute a contact
await client
. sendMute (
'[email protected]' , //contact mute
30 , //duration of silence, example: 30 minutes
'minutes' ///kind of silence "hours" "minutes" "year"
)
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
///unmute contact
await client
. sendMute (
'[email protected]' //contact unmute
)
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Change the theme
// string types "dark" or "light"
await client . setTheme ( 'dark' ) ;
// Receive the current theme
// returns string light or dark
await client . getTheme ( ) ;
// Delete chat
await client . deleteChat ( '[email protected]' ) ;
// Clear chat messages
await client . clearChatMessages ( '[email protected]' ) ;
// Archive and unarchive chat messages with true or false
await client . archiveChat ( chatId , true ) ;
// Delete message (last parameter: delete only locally)
await client
. deleteMessage ( '[email protected]' , [
'[email protected]_B70847EE89E22D20FB86ECA0C1B11609' ,
'[email protected]_B70847EE89E22D20FB86ECA0C1B11777'
] )
. then ( ( result ) => {
console . log ( 'Result: ' , result ) ; //return object success
} )
. catch ( ( erro ) => {
console . error ( 'Error when sending: ' , erro ) ; //return object error
} ) ;
// Mark chat as not seen (returns true if it works)
await client . markUnseenMessage ( '[email protected]' ) ;
// Blocks a user (returns true if it works)
await client . blockContact ( '[email protected]' ) ;
// Unlocks contacts (returns true if it works)
await client . unblockContact ( '[email protected]' ) ; Es gibt einige Tricks für eine bessere Verwendung von Gift.
// function to detect conflits and change status
// Force it to keep the current session
// Possible state values:
// CONFLICT
// CONNECTED
// DEPRECATED_VERSION
// OPENING
// PAIRING
// PROXYBLOCK
// SMB_TOS_BLOCK
// TIMEOUT
// TOS_BLOCK
// UNLAUNCHED
// UNPAIRED
// UNPAIRED_IDLE
client . onStateChange ( ( state ) => {
console . log ( 'State changed: ' , state ) ;
// force whatsapp take over
if ( 'CONFLICT' . includes ( state ) ) client . useHere ( ) ;
// detect disconnect on whatsapp
if ( 'UNPAIRED' . includes ( state ) ) console . log ( 'logout' ) ;
} ) ;
// DISCONNECTED
// SYNCING
// RESUMING
// CONNECTED
let time = 0 ;
client . onStreamChange ( ( state ) => {
console . log ( 'State Connection Stream: ' + state ) ;
clearTimeout ( time ) ;
if ( state === 'DISCONNECTED' || state === 'SYNCING' ) {
time = setTimeout ( ( ) => {
client . close ( ) ;
} , 80000 ) ;
}
} ) ;
// function to detect incoming call
client . onIncomingCall ( async ( call ) => {
console . log ( call ) ;
client . sendText ( call . peerJid , "Sorry, I still can't answer calls" ) ;
} ) ; Schließen Sie die Sitzung ordnungsgemäß, um sicherzustellen, dass die Sitzung zum nächsten Mal gespeichert wird, wenn Sie sich anmelden (sodass sie nicht nach QR -Scan verlangt). Also statt Strg+C,,
// Catch ctrl+C
process . on ( 'SIGINT' , function ( ) {
client . close ( ) ;
} ) ;
// Try-catch close
try {
...
} catch ( error ) {
client . close ( ) ;
}Die automatische Schließung ist standardmäßig aktiviert und das Timeout ist auf 60 Sekunden festgelegt. Erhält die Zeit in Millisekunden bis zu dem Countdown, bis sie gepaart sind.
Verwenden Sie "AutoClosse: 0 | False", um die automatische Schließung zu deaktivieren.
Sie können zwischengespeicherte Versionen von WhatsApp Web verwenden, indem Sie die webVersion -Argumente als Teil Ihrer Venomoptionen bestehen:
venom . create ( {
session : 'sessionname' , //name of session
headless : false ,
logQR : true ,
webVersion : '2.2402.5'
} )
. then ( ( client ) => {
start ( client ) ;
} ) ;Diese Funktion kann jede Version verwenden, die in der Liste unter https://github.com/wppconnect-team/wa-version/tree/main/html verfügbar ist
Das Aufbau von Gift ist wirklich einfach, obwohl es 3 Hauptprojekte im Inneren enthält
> npm run build:wapi > npm run build:middleware
> npm run build:jsQR > npm run build:venomUm das gesamte Projekt aufzubauen, laufen Sie einfach
> npm run buildBetrachten werden benötigt, ich kann nicht alle Updates alleine behalten. Wenn Sie interessiert sind, öffnen Sie bitte eine Pull -Anfrage.
Pull -Anfragen sind willkommen. Für wichtige Änderungen öffnen Sie zuerst ein Problem, um zu besprechen, was Sie ändern möchten.
