Spaces:
Paused
Paused
File size: 7,940 Bytes
4c34106 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | # Creating a Client
To start using `Wppconnect Bot`, create a file and call the {@link create} method.\
That method returns a `Promise` of {@link Whatsapp}.
```javascript
// Supports ES6
// import { create, Whatsapp } from '@wppconnect-team/wppconnect';
const wppconnect = require('@wppconnect-team/wppconnect');
wppconnect
.create()
.then((client) => client.start())
.catch((error) => console.log(error));
```
## Multi sessions
If you want to start more than one session, for example,
in case you have different departments in your project,
then you had to specify it in your code like in that example:
```javascript
// Init sales WhatsApp bot
wppconnect.create({session: 'sales'}).then((client) => client.start());
// Init support WhatsApp bot
wppconnect.create({session: 'support'}).then((client) => client.start());
```
## Passing options on create
The {@link create} method third parameter can have the following optional parameters (see all parameters in {@link CreateOptions}):
```javascript
wppconnect.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 || disconnectedMobile || deleteToken
//Create session wss return "serverClose" case server for close
console.log('Session name: ', session);
},
onLoadingScreen: (percent, message) => {
console.log('LOADING_SCREEN', percent, message);
},
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
browserWS: '', // If you want to use browserWSEndpoint
browserArgs: [''], // Parameters to be added into the Chrome browser instance
puppeteerOptions: {}, // Will be passed to puppeteer.launch
disableWelcome: false, // Option to disable the welcoming message which appears in the beginning
updatesLog: true, // Logs info updates automatically in terminal
autoClose: 60000, // Automatically closes the wppconnect only when scanning the QR code (default 60 seconds, if you want to turn it off, assign 0 or false)
tokenStore: 'file', // Define how to work with tokens, which can be a custom interface
folderNameToken: './tokens', //folder name when saving tokens
// BrowserSessionToken
// To receive the client's token use the function await client.getSessionTokenBrowser()
sessionToken: {
WABrowserId: '"UnXjH....."',
WASecretBundle: '{"key":"+i/nRgWJ....","encKey":"kGdMR5t....","macKey":"+i/nRgW...."}',
WAToken1: '"0i8...."',
WAToken2: '"1@lPpzwC...."',
}
})
.then((client) => client.start())
.catch((error) => console.log(error));
```
### Callback Status Session
More details in {@link StatusFind}
| Status | Condition |
|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `isLogged` | When the user is already logged in to the browser |
| `notLogged` | When the user is not connected to the browser, it is necessary to scan the QR code through the cell phone in the option WhatsApp Web |
| `browserClose` | If the browser is closed this parameter is returned |
| `qrReadSuccess` | If the user is not logged in, the QR code is passed on the terminal a callback is returned. After the correct reading by cell phone this parameter is returned |
| `qrReadFail` | If the browser stops when the QR code scan is in progress, this parameter is returned |
| `autocloseCalled` | The browser was closed using the autoClose command |
| `disconnectedMobile` | Client has disconnected to the mobile device |
| `serverClose` | Client has disconnected in to wss |
| `deleteToken` | If you pass true within the function `client.getSessionTokenBrowser(true)` |
```javascript
const wppconnect = require('@wppconnect-team/wppconnect');
wppconnect
.create({
session: 'sessionName',
statusFind: (statusSession, session) => {
// return: isLogged || notLogged || browserClose || qrReadSuccess || qrReadFail || autocloseCalled || disconnectedMobile || deleteToken
console.log('Status Session: ', statusSession);
// create session wss return "serverClose" case server for close
console.log('Session name: ', session);
},
})
.then((client) => client.start())
.catch((error) => console.log(error));
```
### Phone connection verification
To enforce the phone connection verification, you can use the code below or check the documentation {@link Whatsapp.startPhoneWatchdog}.:
```javascript
// To start with default interval.
client.startPhoneWatchdog();
// To start with custom interval.
client.startPhoneWatchdog(30000); // 30s
// To stop.
client.stopPhoneWatchdog();
```
### Exporting QR Code
By default, a QR code will appear on the terminal. If you need to pass the QR
somewhere else here is how (See {@link CatchQRCallback}):
```javascript
const fs = require('fs');
const wppconnect = require('@wppconnect-team/wppconnect');
wppconnect
.create({
session: 'sessionName',
catchQR: (base64Qr, asciiQR) => {
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);
}
}
);
},
logQR: false,
})
.then((client) => client.start())
.catch((error) => console.log(error));
```
### Saving Session Token
Read the {@link TokenStore}
### Multidevice (BETA)
To use multidevice account, you have to set a fixed user data dir for the browser to keep it logged,
because WhatsApp changed the way of authentication.
To setup this, you can use the example below:
```javascript
wppconnect
.create({
// ...
session: 'mySessionName',
puppeteerOptions: {
userDataDir: './tokens/mySessionName', // or your custom directory
},
// ...
})
.then((client) => client.start())
.catch((error) => console.log(error));
```
|