+
+
+
+
+ Class CallbackOnStatus
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ emit
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + CallbackOnStatus + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Methods
+-
+
- emit
Status Find
+ - on +
Constructors
+constructor
+-
+
+
-
+
-
+
+
Returns CallbackOnStatus
+
+
Methods
+emitStatusFind
+ -
+
+
-
+
-
+
+ ++++
Emit an event with the specified type and arguments
+Parameters
+-
+
-
+
args: any
+++Event arguments, including onType to specify the event type
+
+
Returns void
+
+ -
+
on
+-
+
+
-
+
-
+
+ ++++
Listen for specific user events
+Parameters
+-
+
-
+
type: OnMode
+++Type of event to monitor
+
+ -
+
callback: (state: any) => void
+++Function to call with event data
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
state: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/GroupLayer.html b/classes/GroupLayer.html
new file mode 100644
index 0000000..1fce735
--- /dev/null
+++ b/classes/GroupLayer.html
@@ -0,0 +1,948 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class GroupLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ auto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+ url
+
+
+
+
+
+
+
+ add
+
+
+
+ ascii
+
+
+
+ cancel
+
+
+
+ create
+
+
+
+ decrypt
+
+
+
+ init
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+ qr
+
+
+
+ qr
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+ Hierarchy
+-
+
-
+ ListenerLayer
+
-
+
-
+ GroupLayer
+
-
+
- + RetrieverLayer + +
+
+ -
+ GroupLayer
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- auto
Close Interval
+ - auto
Close Remain
+ - browser +
- ev +
- options +
- page +
- start
Scan Qrcode
+ - url
Code
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: any
+
+
Returns GroupLayer
+
+ -
+
Properties
+autoCloseInterval
+
+
+ autoCloseRemain
+
+
+ browser
+ + +ev
+ + +options
+ + +page
+ + +startScanQrcode
+
+
+ urlCode
+
+
+ Methods
+addParticipant
+ -
+
+
-
+
-
+
+ ++++
Adds participant to Group
+Parameters
+-
+
-
+
groupId: string
+++Chat id ('0000000000-00000000@g.us' or '000000000000000000@g.us')
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
asciiQr
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
code: string
+
+
Returns Promise<string>
+
+ -
+
cancelAutoClose
+ -
+
+
-
+
-
+
+
Returns void
+
+
createGroup
+ -
+
+
-
+
-
+
+ ++++
Creates a new chat group
+Parameters
+-
+
-
+
groupName: string
+++Group name
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
decryptFile
+ -
+
+
-
+
-
+
+ ++++
Decrypts message file
+Parameters
+-
+
-
+
message: any
+++Message object
+
+
Returns Promise<Buffer>
+Decrypted file buffer (null otherwise)
+
+ -
+
initListener
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
qrCode
+ -
+
+
-
+
-
+
+
Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
+
+
qrCodeScan
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
setGroupDescription
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group description
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
description: string
+++group description
+
+
Returns Promise<InterfaceScope>
+
+ -
+
setGroupImage
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group image
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
path: string
+++of image
+
+
Returns Promise<InterfaceScope>
+
+ -
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/ListenerLayer.html b/classes/ListenerLayer.html
new file mode 100644
index 0000000..4c54b28
--- /dev/null
+++ b/classes/ListenerLayer.html
@@ -0,0 +1,781 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class ListenerLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ auto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+ url
+
+
+
+
+
+
+
+ ascii
+
+
+
+ cancel
+
+
+
+ decrypt
+
+
+
+ init
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+ qr
+
+
+
+ qr
+
+
+
+
+ Hierarchy
+-
+
-
+ Whatsapp
+
-
+
-
+ ListenerLayer
+
-
+
- + GroupLayer + +
+
+ -
+ ListenerLayer
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- auto
Close Interval
+ - auto
Close Remain
+ - browser +
- ev +
- options +
- page +
- start
Scan Qrcode
+ - url
Code
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: CallbackOnStatus
+
+
Returns ListenerLayer
+
+ -
+
Properties
+autoCloseInterval
+
+
+ autoCloseRemain
+
+
+ browser
+ + +ev
+ + +options
+ + +page
+ + +startScanQrcode
+
+
+ urlCode
+
+
+ Methods
+asciiQr
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
code: string
+
+
Returns Promise<string>
+
+ -
+
cancelAutoClose
+ -
+
+
-
+
-
+
+
Returns void
+
+
decryptFile
+ -
+
+
-
+
-
+
+ ++++
Decrypts message file
+Parameters
+-
+
-
+
message: any
+++Message object
+
+
Returns Promise<Buffer>
+Decrypted file buffer (null otherwise)
+
+ -
+
initListener
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
qrCode
+ -
+
+
-
+
-
+
+
Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
+
+
qrCodeScan
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/OnMod.html b/classes/OnMod.html
new file mode 100644
index 0000000..53a7997
--- /dev/null
+++ b/classes/OnMod.html
@@ -0,0 +1,554 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class OnMod
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+
+ Hierarchy
+-
+
-
+ OnMod
+
-
+
- + Scraping + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: any
+
+
Returns OnMod
+
+ -
+
Properties
+browser
+ + +ev
+ + +options
+ + +page
+ + +Methods
+interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/RetrieverLayer.html b/classes/RetrieverLayer.html
new file mode 100644
index 0000000..4b6a373
--- /dev/null
+++ b/classes/RetrieverLayer.html
@@ -0,0 +1,1094 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class RetrieverLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ auto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+ url
+
+
+
+
+
+
+
+ add
+
+
+
+ ascii
+
+
+
+ cancel
+
+
+
+ check
+
+
+
+ create
+
+
+
+ decrypt
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+ init
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+ qr
+
+
+
+ qr
+
+
+
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+ Hierarchy
+-
+
-
+ GroupLayer
+
-
+
-
+ RetrieverLayer
+
-
+
- + SenderLayer + +
+
+ -
+ RetrieverLayer
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- auto
Close Interval
+ - auto
Close Remain
+ - browser +
- ev +
- options +
- page +
- start
Scan Qrcode
+ - url
Code
+
Methods
+-
+
- add
Participant
+ - ascii
Qr
+ - cancel
Auto Close
+ - check
Number
+ - create
Group
+ - decrypt
File
+ - get
All Contacts
+ - get
Host
+ - getWAVersion +
- init
Listener
+ - interface
Change
+ - new
Delete Message
+ - new
Edit Message
+ - new
Message
+ - new
OnAck
+ - on
Intro Reaction Message
+ - on
Reaction Message
+ - qr
Code
+ - qr
Code Scan
+ - screenshot +
- set
Group Description
+ - set
Group Image
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: any
+
+
Returns RetrieverLayer
+
+ -
+
Properties
+autoCloseInterval
+
+
+ autoCloseRemain
+
+
+ browser
+ + +ev
+ + +options
+ + +page
+ + +startScanQrcode
+
+
+ urlCode
+
+
+ Methods
+addParticipant
+ -
+
+
-
+
-
+
+ ++++
Adds participant to Group
+Parameters
+-
+
-
+
groupId: string
+++Chat id ('0000000000-00000000@g.us' or '000000000000000000@g.us')
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
asciiQr
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
code: string
+
+
Returns Promise<string>
+
+ -
+
cancelAutoClose
+ -
+
+
-
+
-
+
+
Returns void
+
+
checkNumber
+ -
+
+
-
+
-
+
+ ++++
Check if the number exists
+Parameters
+-
+
-
+
number: string
+++phone number
+
+
Returns Promise<any>
+
+ -
+
createGroup
+ -
+
+
-
+
-
+
+ ++++
Creates a new chat group
+Parameters
+-
+
-
+
groupName: string
+++Group name
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
decryptFile
+ -
+
+
-
+
-
+
+ ++++
Decrypts message file
+Parameters
+-
+
-
+
message: any
+++Message object
+
+
Returns Promise<Buffer>
+Decrypted file buffer (null otherwise)
+
+ -
+
getAllContacts
+ -
+
+
-
+
-
+
+ ++++
returns a list of contacts
+Returns Promise<Contact>
+contacts
+
+
getHost
+ -
+
+
-
+
-
+
+ ++++
Get information from the connected number
+Returns Promise<InterfaceHost>
+Current host device details
+
+
getWAVersion
+-
+
+
-
+
-
+
+ ++++
Get version of the current whatsapp
+Returns Promise<string>
+
+
initListener
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
qrCode
+ -
+
+
-
+
-
+
+
Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
+
+
qrCodeScan
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
screenshot
+-
+
+
-
+
-
+
+ ++++
Get screenshot
+Returns Promise<{ base64Image: string }>
+base64 image
+
+
setGroupDescription
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group description
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
description: string
+++group description
+
+
Returns Promise<InterfaceScope>
+
+ -
+
setGroupImage
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group image
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
path: string
+++of image
+
+
Returns Promise<InterfaceScope>
+
+ -
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/Scraping.html b/classes/Scraping.html
new file mode 100644
index 0000000..b9a65fb
--- /dev/null
+++ b/classes/Scraping.html
@@ -0,0 +1,682 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class Scraping
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ auto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+
+
+ ascii
+
+
+
+ cancel
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+ qr
+
+
+
+
+ Hierarchy
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- auto
Close Interval
+ - auto
Close Remain
+ - browser +
- ev +
- options +
- page +
- start
Scan Qrcode
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: any
+
+
Returns Scraping
+
+ -
+
Properties
+autoCloseInterval
+
+
+ autoCloseRemain
+
+
+ browser
+ + +ev
+ + +options
+ + +page
+ + +startScanQrcode
+
+
+ Methods
+asciiQr
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
code: string
+
+
Returns Promise<string>
+
+ -
+
cancelAutoClose
+ -
+
+
-
+
-
+
+
Returns void
+
+
interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
qrCode
+ -
+
+
-
+
-
+
+
Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/SenderLayer.html b/classes/SenderLayer.html
new file mode 100644
index 0000000..8cc20da
--- /dev/null
+++ b/classes/SenderLayer.html
@@ -0,0 +1,1390 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class SenderLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ auto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+ url
+
+
+
+
+
+
+
+ add
+
+
+
+ ascii
+
+
+
+ cancel
+
+
+
+ check
+
+
+
+ create
+
+
+
+ decrypt
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+ init
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+ qr
+
+
+
+ qr
+
+
+
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+ Hierarchy
+-
+
-
+ RetrieverLayer
+
-
+
-
+ SenderLayer
+
-
+
- + WebPack + +
+
+ -
+ SenderLayer
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- auto
Close Interval
+ - auto
Close Remain
+ - browser +
- ev +
- options +
- page +
- start
Scan Qrcode
+ - url
Code
+
Methods
+-
+
- add
Participant
+ - ascii
Qr
+ - cancel
Auto Close
+ - check
Number
+ - create
Group
+ - decrypt
File
+ - get
All Contacts
+ - get
Host
+ - getWAVersion +
- init
Listener
+ - interface
Change
+ - new
Delete Message
+ - new
Edit Message
+ - new
Message
+ - new
OnAck
+ - on
Intro Reaction Message
+ - on
Reaction Message
+ - qr
Code
+ - qr
Code Scan
+ - screenshot +
- send
Audio
+ - send
Audio Base64
+ - send
File
+ - send
Image
+ - send
Image From Base64
+ - send
Message
+ - send
Text
+ - set
Group Description
+ - set
Group Image
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: any
+
+
Returns SenderLayer
+
+ -
+
Properties
+autoCloseInterval
+
+
+ autoCloseRemain
+
+
+ browser
+ + +ev
+ + +options
+ + +page
+ + +startScanQrcode
+
+
+ urlCode
+
+
+ Methods
+addParticipant
+ -
+
+
-
+
-
+
+ ++++
Adds participant to Group
+Parameters
+-
+
-
+
groupId: string
+++Chat id ('0000000000-00000000@g.us' or '000000000000000000@g.us')
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
asciiQr
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
code: string
+
+
Returns Promise<string>
+
+ -
+
cancelAutoClose
+ -
+
+
-
+
-
+
+
Returns void
+
+
checkNumber
+ -
+
+
-
+
-
+
+ ++++
Check if the number exists
+Parameters
+-
+
-
+
number: string
+++phone number
+
+
Returns Promise<any>
+
+ -
+
createGroup
+ -
+
+
-
+
-
+
+ ++++
Creates a new chat group
+Parameters
+-
+
-
+
groupName: string
+++Group name
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
decryptFile
+ -
+
+
-
+
-
+
+ ++++
Decrypts message file
+Parameters
+-
+
-
+
message: any
+++Message object
+
+
Returns Promise<Buffer>
+Decrypted file buffer (null otherwise)
+
+ -
+
getAllContacts
+ -
+
+
-
+
-
+
+ ++++
returns a list of contacts
+Returns Promise<Contact>
+contacts
+
+
getHost
+ -
+
+
-
+
-
+
+ ++++
Get information from the connected number
+Returns Promise<InterfaceHost>
+Current host device details
+
+
getWAVersion
+-
+
+
-
+
-
+
+ ++++
Get version of the current whatsapp
+Returns Promise<string>
+
+
initListener
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
qrCode
+ -
+
+
-
+
-
+
+
Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
+
+
qrCodeScan
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
screenshot
+-
+
+
-
+
-
+
+ ++++
Get screenshot
+Returns Promise<{ base64Image: string }>
+base64 image
+
+
sendAudio
+ -
+
+
-
+
-
+
+ ++++
Send audio file
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
filePath: string
+++Path file
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendAudioBase64
+ -
+
+
-
+
-
+
+ ++++
Send audio base64
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
base64: string
+++base64 data
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendFile
+ -
+
+
-
+
-
+
+ ++++
Sends file from path
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
filePath: string
+++File path
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendImage
+ -
+
+
-
+
-
+
+ ++++
Sends image message
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
filePath: string
+++File path or http link
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendImageFromBase64
+ -
+
+
-
+
-
+
+ ++++
Sends image message base64
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
base64: string
+++File path, http link or base64Encoded
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendMessage
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
options: SendOptions
+
+
Returns Promise<any>
+
+ -
+
sendText
+ -
+
+
-
+
-
+
+ ++++
Sends a text message to given chat
+Parameters
+-
+
-
+
to: string
+++chat id: xxxxx@us.c
+
+ -
+
body: string
+++text message
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
setGroupDescription
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group description
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
description: string
+++group description
+
+
Returns Promise<InterfaceScope>
+
+ -
+
setGroupImage
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group image
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
path: string
+++of image
+
+
Returns Promise<InterfaceScope>
+
+ -
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/WebPack.html b/classes/WebPack.html
new file mode 100644
index 0000000..1d424fd
--- /dev/null
+++ b/classes/WebPack.html
@@ -0,0 +1,1427 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class WebPack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ auto
+
+
+
+
+
+
+
+
+
+
+
+ load
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+ url
+
+
+
+
+
+
+
+ add
+
+
+
+ ascii
+
+
+
+ cancel
+
+
+
+ check
+
+
+
+ create
+
+
+
+ decrypt
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+ init
+
+
+
+ init
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+ qr
+
+
+
+ qr
+
+
+
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ send
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+ Hierarchy
+-
+
-
+ SenderLayer
+
-
+
- + WebPack + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- auto
Close Interval
+ - auto
Close Remain
+ - browser +
- ev +
- load
Page Status
+ - options +
- page +
- start
Scan Qrcode
+ - url
Code
+
Methods
+-
+
- add
Participant
+ - ascii
Qr
+ - cancel
Auto Close
+ - check
Number
+ - create
Group
+ - decrypt
File
+ - get
All Contacts
+ - get
Host
+ - getWAVersion +
- init
Listener
+ - init
Service
+ - interface
Change
+ - new
Delete Message
+ - new
Edit Message
+ - new
Message
+ - new
OnAck
+ - on
Intro Reaction Message
+ - on
Reaction Message
+ - qr
Code
+ - qr
Code Scan
+ - screenshot +
- send
Audio
+ - send
Audio Base64
+ - send
File
+ - send
Image
+ - send
Image From Base64
+ - send
Message
+ - send
Text
+ - set
Group Description
+ - set
Group Image
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: unknown
+
+
Returns WebPack
+
+ -
+
Properties
+autoCloseInterval
+
+
+ autoCloseRemain
+
+
+ browser
+ + +ev
+ + +loadPageStatus
+
+
+ options
+ + +page
+ + +startScanQrcode
+
+
+ urlCode
+
+
+ Methods
+addParticipant
+ -
+
+
-
+
-
+
+ ++++
Adds participant to Group
+Parameters
+-
+
-
+
groupId: string
+++Chat id ('0000000000-00000000@g.us' or '000000000000000000@g.us')
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
asciiQr
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
code: string
+
+
Returns Promise<string>
+
+ -
+
cancelAutoClose
+ -
+
+
-
+
-
+
+
Returns void
+
+
checkNumber
+ -
+
+
-
+
-
+
+ ++++
Check if the number exists
+Parameters
+-
+
-
+
number: string
+++phone number
+
+
Returns Promise<any>
+
+ -
+
createGroup
+ -
+
+
-
+
-
+
+ ++++
Creates a new chat group
+Parameters
+-
+
-
+
groupName: string
+++Group name
+
+ -
+
contacts: string | string[]
+++Participants id '000000000000@c.us'
+
+
Returns Promise<InterfaceScope>
+
+ -
+
decryptFile
+ -
+
+
-
+
-
+
+ ++++
Decrypts message file
+Parameters
+-
+
-
+
message: any
+++Message object
+
+
Returns Promise<Buffer>
+Decrypted file buffer (null otherwise)
+
+ -
+
getAllContacts
+ -
+
+
-
+
-
+
+ ++++
returns a list of contacts
+Returns Promise<Contact>
+contacts
+
+
getHost
+ -
+
+
-
+
-
+
+ ++++
Get information from the connected number
+Returns Promise<InterfaceHost>
+Current host device details
+
+
getWAVersion
+-
+
+
-
+
-
+
+ ++++
Get version of the current whatsapp
+Returns Promise<string>
+
+
initListener
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
initService
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
qrCode
+ -
+
+
-
+
-
+
+
Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
+
+
qrCodeScan
+ -
+
+
-
+
-
+
+
Returns Promise<void>
+
+
screenshot
+-
+
+
-
+
-
+
+ ++++
Get screenshot
+Returns Promise<{ base64Image: string }>
+base64 image
+
+
sendAudio
+ -
+
+
-
+
-
+
+ ++++
Send audio file
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
filePath: string
+++Path file
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendAudioBase64
+ -
+
+
-
+
-
+
+ ++++
Send audio base64
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
base64: string
+++base64 data
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendFile
+ -
+
+
-
+
-
+
+ ++++
Sends file from path
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
filePath: string
+++File path
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendImage
+ -
+
+
-
+
-
+
+ ++++
Sends image message
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
filePath: string
+++File path or http link
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendImageFromBase64
+ -
+
+
-
+
-
+
+ ++++
Sends image message base64
+Parameters
+-
+
-
+
to: string
+++Chat id
+
+ -
+
base64: string
+++File path, http link or base64Encoded
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
sendMessage
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
options: SendOptions
+
+
Returns Promise<any>
+
+ -
+
sendText
+ -
+
+
-
+
-
+
+ ++++
Sends a text message to given chat
+Parameters
+-
+
-
+
to: string
+++chat id: xxxxx@us.c
+
+ -
+
body: string
+++text message
+
+ -
+
options: any = {}
+
+
Returns Promise<unknown>
+
+ -
+
setGroupDescription
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group description
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
description: string
+++group description
+
+
Returns Promise<InterfaceScope>
+
+ -
+
setGroupImage
+ -
+
+
-
+
-
+
+ ++++
Parameters to change group image
+Parameters
+-
+
-
+
groupId: string
+++group number
+
+ -
+
path: string
+++of image
+
+
Returns Promise<InterfaceScope>
+
+ -
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/Whatsapp.html b/classes/Whatsapp.html
new file mode 100644
index 0000000..6505561
--- /dev/null
+++ b/classes/Whatsapp.html
@@ -0,0 +1,724 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Class Whatsapp
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ auto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+
+
+ ascii
+
+
+
+ cancel
+
+
+
+ decrypt
+
+
+
+ interface
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+ qr
+
+
+
+
+ Hierarchy
+-
+
-
+ Scraping
+
-
+
-
+ Whatsapp
+
-
+
- + ListenerLayer + +
+
+ -
+ Whatsapp
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- auto
Close Interval
+ - auto
Close Remain
+ - browser +
- ev +
- options +
- page +
- start
Scan Qrcode
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
page: Page
+
+ -
+
browser: Browser
+
+ -
+
options: CreateOptions
+
+ -
+
ev: any
+
+
Returns Whatsapp
+
+ -
+
Properties
+autoCloseInterval
+
+
+ autoCloseRemain
+
+
+ browser
+ + +ev
+ + +options
+ + +page
+ + +startScanQrcode
+
+
+ Methods
+asciiQr
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
code: string
+
+
Returns Promise<string>
+
+ -
+
cancelAutoClose
+ -
+
+
-
+
-
+
+
Returns void
+
+
decryptFile
+ -
+
+
-
+
-
+
+ ++++
Decrypts message file
+Parameters
+-
+
-
+
message: any
+++Message object
+
+
Returns Promise<Buffer>
+Decrypted file buffer (null otherwise)
+
+ -
+
interfaceChange
+ -
+
+
-
+
-
+
+ ++++
Listen to interface changes.
+Returns void
+
+
newDeleteMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to deleted messages.
+Returns void
+
+
newEditMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to edited messages.
+Returns void
+
+
newMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to new messages.
+Returns void
+
+
newOnAck
+ -
+
+
-
+
-
+
+ ++++
Listen to message acknowledgment (read receipt).
+Returns void
+
+
onIntroReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to introductory reactions.
+Returns void
+
+
onReactionMessage
+ -
+
+
-
+
-
+
+ ++++
Listen to reaction messages.
+Returns void
+
+
qrCode
+ -
+
+
-
+
-
+
+
Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/enums/FunctionType.html b/enums/FunctionType.html
new file mode 100644
index 0000000..d312afd
--- /dev/null
+++ b/enums/FunctionType.html
@@ -0,0 +1,377 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Enumeration FunctionType
+
+
+
+
+
+
+
+
+
+
+
+
+
+ send
+
+
+
+
+
+ send
+
+
+
+
+
+ send
+
+
+
+
+
+ send
+
+
+
+
+
+ send
+
+
+
+
+
+ send
+
+
+
+
+
+
+ Index
+
+
+
+
+ Enumeration members
+-
+
- send
Audio
+ - send
Audio Base64
+ - send
File
+ - send
Image
+ - send
Image From Base64
+ - send
Text
+
Enumeration members
+sendAudio
+
+
+
+
+
+
+ send an audio message
+sendAudioBase64
+
+
+
+
+
+
+ send audio in base64
+sendFile
+
+
+
+
+
+
+ send file message
+sendImage
+
+
+
+
+
+
+ send image file
+sendImageFromBase64
+
+
+
+
+
+
+ send image in base64
+sendText
+
+
+
+
+
+
+ send text message
+
+
+
+
+
+
\ No newline at end of file
diff --git a/enums/InterfaceMode.html b/enums/InterfaceMode.html
new file mode 100644
index 0000000..af87361
--- /dev/null
+++ b/enums/InterfaceMode.html
@@ -0,0 +1,453 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Enumeration InterfaceMode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DEPRECATED_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SMB_
+
+
+
+
+
+
+
+
+ TOS_
+
+
+
+
+
+
+ Index
+
+
+
+
+ Enumeration members
+-
+
- CONFLICT +
- CONNECTION +
- DEPRECATED_
VERSION
+ - MAIN +
- OFFLINE +
- PROXYBLOCK +
- QR +
- SMB_
TOS_ BLOCK
+ - SYNCING +
- TOS_
BLOCK
+
Enumeration members
+CONFLICT
+ + +
+
+
+
+ Conflic page, when there are another whatsapp web openned.
+CONNECTION
+ + +
+
+
+
+ Connection.
+DEPRECATED_VERSION
+
+
+
+
+
+
+ Deprecated page.
+MAIN
+ + +
+
+
+
+ Chat page.
+OFFLINE
+ + +
+
+
+
+ Offline page, when there are no internet.
+PROXYBLOCK
+ + +
+
+
+
+ Blocked page, by proxy.
+QR
+ + +
+
+
+
+ QR code page.
+SMB_TOS_BLOCK
+
+
+
+
+
+
+ Blocked page.
+SYNCING
+ + +
+
+
+
+ Loading page, waiting data from smartphone.
+TOS_BLOCK
+
+
+
+
+
+
+ Blocked page.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/enums/OnMode.html b/enums/OnMode.html
new file mode 100644
index 0000000..275a190
--- /dev/null
+++ b/enums/OnMode.html
@@ -0,0 +1,434 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Enumeration OnMode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ interface
+
+
+
+
+
+ new
+
+
+
+
+
+ new
+
+
+
+
+
+ new
+
+
+
+
+
+ new
+
+
+
+
+
+ on
+
+
+
+
+
+ on
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Enumeration members
+ +Enumeration members
+connection
+ + +
+
+
+
+ user connection information
+interfaceChange
+
+
+
+
+
+
+ receive which interface the user is on!
+newDeleteMessage
+
+
+
+
+
+
+ Receive new messages deleted
+newEditMessage
+
+
+
+
+
+
+ Receive new messages edited
+newMessage
+
+
+
+
+
+
+ monitor new messages
+newOnAck
+
+
+
+
+
+
+ monitor the status of a message
+onIntroReactionMessage
+
+
+
+
+
+
+ Receive new message intro reactions emoji (It is triggered upon entering the chat, loading all available emojis. It is also triggered when a new emoji is sent in any chat)
+onReactionMessage
+
+
+
+
+
+
+ Receive new messagens reactions emoji
+qrcode
+ + +
+
+
+
+ receive QRCODE updates
+
+
+
+
+
+
\ No newline at end of file
diff --git a/enums/ReactionType.html b/enums/ReactionType.html
new file mode 100644
index 0000000..7c7e865
--- /dev/null
+++ b/enums/ReactionType.html
@@ -0,0 +1,291 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Enumeration ReactionType
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/enums/TypeStatusFind.html b/enums/TypeStatusFind.html
new file mode 100644
index 0000000..587d2a4
--- /dev/null
+++ b/enums/TypeStatusFind.html
@@ -0,0 +1,415 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Enumeration TypeStatusFind
+
+
+
+
+
+
+
+
+
+
+
+
+
+ auto
+
+
+
+
+
+ browser
+
+
+
+
+
+
+
+
+ init
+
+
+
+
+
+ init
+
+
+
+
+
+ no
+
+
+
+
+
+ no
+
+
+
+
+
+ opened
+
+
+
+
+
+
+ Index
+
+
+
+
+ Enumeration members
+-
+
- auto
Close
+ - browser
Closed
+ - chromium +
- init
Browser
+ - init
Whatsapp
+ - no
Open Browser
+ - no
Open Whatzapp
+ - opened
Whatsapp
+
Enumeration members
+autoClose
+
+
+
+
+
+
+ Auto close called!
+browserClosed
+
+
+
+
+
+
+ The browser has closed
+chromium
+ + +
+
+
+
+ Process chromium download
+initBrowser
+
+
+
+
+
+
+ Starting browser
+initWhatsapp
+
+
+
+
+
+
+ Opening whatsapp page
+noOpenBrowser
+
+
+
+
+
+
+ Error open browser
+noOpenWhatzapp
+
+
+
+
+
+
+ Error open whatzapp
+openedWhatsapp
+
+
+
+
+
+
+ Website accessed successfully
+
+
+
+
+
+
\ No newline at end of file
diff --git a/img/.gitkeep b/img/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/img/2022-06-03_23-26-08.gif b/img/2022-06-03_23-26-08.gif
new file mode 100644
index 0000000..e42e78b
Binary files /dev/null and b/img/2022-06-03_23-26-08.gif differ
diff --git a/img/documentation.png b/img/documentation.png
new file mode 100644
index 0000000..4c00116
Binary files /dev/null and b/img/documentation.png differ
diff --git a/img/hydra.png b/img/hydra.png
new file mode 100644
index 0000000..950444f
Binary files /dev/null and b/img/hydra.png differ
diff --git a/img/logo-horizontal.webp b/img/logo-horizontal.webp
new file mode 100644
index 0000000..28b030a
Binary files /dev/null and b/img/logo-horizontal.webp differ
diff --git a/img/logo-redrive-png.png b/img/logo-redrive-png.png
new file mode 100644
index 0000000..155efc7
Binary files /dev/null and b/img/logo-redrive-png.png differ
diff --git a/img/logo_zaplus.png b/img/logo_zaplus.png
new file mode 100644
index 0000000..c343a08
Binary files /dev/null and b/img/logo_zaplus.png differ
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..b940acd
--- /dev/null
+++ b/index.html
@@ -0,0 +1,1061 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+ hydra-bot - v1.0.33
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ 
+
+
+
+
+ List of commands using
+
+
+ All user wheels have a pattern of
+
+
+
+
+
+ All whatsapp connection wheels have a pattern of
+
+
+
+
+
+
+
+
+
+ Here,
+
+
+ Status repository
+ +
+ 
+ 
+ 
Our online channels
+ +
Welcome to Hydra Bot
+ +
++This project was developed to help the community that uses whatsapp as a way to implement an API quickly and effectively, for companies and much more! Thank you for being part of this family.
+
You can use this project in two ways, the first is using Web Services using a set of well-defined operations, the POST, GET, PUT and DELETE methods, the second option is to use the bot in raw form, without using a Web Services.
+ +
+
+
+ WhatSapp Group
+ + +
+ Do you have any doubt? Need help? Join our whatsapp group and ask your questions with other people!
+ +Installation
+ +Use the stable version:
+> npm i --save hydra-bot
+or for Nightly releases:
+> npm i --save https://github.com/jonalan7/Hydra-bot/releases/download/nightly/hydra-nightly.tgz
+Terminal Admin:
+> yarn admin
+Install yarn Ubuntu:
+> curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+> echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+> sudo apt update && sudo apt install yarn
+> yarn
+Getting started Web Service
+ +The service will be started on localhost on port 8080
+const hydraBot = require('hydra-bot');
+(async () => {
+ // start Web Service
+ const WS = await hydraBot.initWs();
+})();
+Getting started bot (the bot in raw form, without using a Web Services).
+ +If you want to work in free mode, using only the bot, dry the necessary information!
+const hydraBot = require('hydra-bot');
+const mime = require('mime-types');
+const fs = require('fs');
+
+(async () => {
+ let client;
+ // start bot service
+ const ev = await hydraBot.initServer();
+
+ // return to current whatsapp interface
+ ev.on('interfaceChange', (change) => {
+ console.log('interfaceChange: ', change);
+ });
+
+ // return qrcode parameters
+ ev.on('qrcode', (qrcode) => {
+ console.log('qrcode: ', qrcode);
+ });
+
+ // return connection information
+ ev.on('connection', async (conn) => {
+ // browser information!
+ if (conn.statusFind === 'browser') {
+ console.log('info Browser: ', conn.text);
+ }
+
+ // Was connected to whatsapp chat
+ if (conn.connect) {
+ client = conn.client; // class client from hydra-bot
+ const getMe = await client.getHost();
+ const hostNumber = getMe.id._serialized; // number host
+ console.log('Host Number: ', hostNumber);
+
+ // send a text message
+ await client
+ .sendMessage({
+ to: hostNumber, // you can pass the contact number or group number
+ body: "hi i'm hydra bot", // message text
+ options: {
+ type: 'sendText', // shipping type
+ },
+ })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+ }
+ });
+
+ // return receive new messages
+ ev.on('newMessage', async (newMsg) => {
+ // when is received
+ if (!newMsg.result.fromMe) {
+ // message received!
+ console.log('NewMessageReceived: ', newMsg.result);
+ // dowload files
+ if (newMsg.result.isMedia) {
+ const buffer = await client.decryptFile(newMsg.result);
+ // 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(
+ newMsg.result.mimetype
+ )}`;
+ fs.writeFile(fileName, buffer, (err) => {
+ if (err) {
+ console.log(err);
+ }
+ });
+ }
+ }
+ // when is it sent
+ if (!!newMsg.result.fromMe) {
+ // Message sent
+ console.log('NewMessageSent: ', newMsg.result);
+ }
+ });
+
+ // returns the status of each message
+ ev.on('newOnAck', async (event) => {
+ console.log('id Message: ', event.result.id._serialized); // message id
+ console.log('Status Message: ', event.result.ack); // -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
+ console.log('From Message: ', event.result.from); // from message
+ console.log('To Message: ', event.result.to); // to message
+ });
+})();
+Downloading Files
+ +Puppeteer takes care of the file downloading. The decryption is being done as + fast as possible (outruns native methods). Supports big files!
+const hydraBot = require('hydra-bot');
+const fs = require('fs');
+const mime = require('mime-types');
+
+(async () => {
+ let client;
+ // start bot service
+ const ev = await hydraBot.initServer();
+
+ // return connection information
+ ev.on('connection', async (conn) => {
+ // Was connected to whatsapp chat
+ if (conn.connect) {
+ client = conn.client;
+ }
+ });
+
+ ev.on('newMessage', async (newMsg) => {
+ // when is received
+ if (!newMsg.result.fromMe) {
+ // message received!
+ console.log('NewMessageReceived: ', newMsg.result);
+ // dowload files
+ if (newMsg.result.isMedia) {
+ const buffer = await client.decryptFile(newMsg.result);
+ // 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(
+ newMsg.result.mimetype
+ )}`;
+ fs.writeFile(fileName, buffer, (err) => {
+ if (err) {
+ console.log(err);
+ }
+ });
+ }
+ }
+ });
+})();
+Optional create parameters (the bot in raw form, without using a Web Services)
+ +const hydraBot = require('hydra-bot');
+
+hydraBot.initServer({
+ session: 'session', // Name of the token to be generated, a folder with all customer information will be created
+ pathNameToken: 'token', // The path and name of the folder where the client tokens will be saved
+ printQRInTerminal: true, // The QR CODE will be printed on the terminal if true
+ updatesLog: true, // Logs info updates automatically in terminal
+ timeAutoClose: 60000, // If you don't read the QR CODE by default 60 seconds, it will automatically close the client's browser to save memory, if you want to disable it, set 0 or false
+ mkdirFolderToken: '', // Token folder path, only inside the project
+ puppeteerOptions: {
+ headless: true, // Start the project with the browser open or not!
+ args: [], // Additional arguments to pass to the browser instance. adding any parameter you will replace the default args of the project
+ executablePath: 'useChrome', // The browser that will be used for the project, you can specify a path, if you don't pass any parameters it will open the installed browser.
+ },
+});
+Optional create parameters Web Services
+ +const hydraBot = require('hydra-bot');
+
+hydraBot.initWs({
+ hostServer: 'http://localhost',
+ port: '8080',
+ url: '', // point a URL to receive a callback!
+ authentication: true, // ask for authentication in routes
+ pathNameToken: 'token', // The path and name of the folder where the client tokens will be saved
+ printQRInTerminal: true, // The QR CODE will be printed on the terminal if true
+ updatesLog: true, // Logs info updates automatically in terminal
+ timeAutoClose: 60000, // If you don't read the QR CODE by default 60 seconds, it will automatically close the client's browser to save memory, if you want to disable it, set 0 or false
+ mkdirFolderToken: '', // Token folder path, only inside the project
+ puppeteerOptions: {
+ headless: true, // Start the project with the browser open or not!
+ args: [], // Additional arguments to pass to the browser instance. adding any parameter you will replace the default args of the project
+ executablePath: 'useChrome', // The browser that will be used for the project, you can specify a path, if you don't pass any parameters it will open the installed browser.
+ },
+});
+Commands for administration via terminal
+ +To start the administration interface use:
+> yarn admin
+List of commands in the terminal:
+| Command | +Description | +
|---|---|
/create |
+ Create user | +
/delete |
+ Delete user | +
/selectid |
+ Show user by id | +
/selectname |
+ Select user by name | +
/getall |
+ List all users | +
/deactivate |
+ Disable user | +
/activate |
+ Activate User | +
/changename |
+ Change username | +
/password |
+ Change user password | +
/cls |
+ Clear screen/terminal | +
/help |
+ List all commands for administration in terminal | +
/exit |
+ Exit manager | +
Routes for handling and querying users.
+ + +List of commands using REST API
+
+
+ All user wheels have a pattern of Headers, to be able to access them, to create a administrator
+
+ {
+ "Content-Type": "application/json",
+ "admin": "admin",
+ "admin_pass": "admin"
+}
+List of routes for user management:
+ +| Type | +Route to browser | +Description | +Body | +
|---|---|---|---|
| POST | +/create_user |
+ Create user | +{"name":"USE","password":"USER PASSWORD"} |
+
| DEL | +/delete_user/ID_USE |
+ Delete user | +EMPTY |
+
| GET | +/get_user_by_id/ID_USE |
+ Show user by ID | +EMPTY |
+
| GET | +/get_all_users |
+ List all users | +EMPTY |
+
| PUT | +/deactivate_user |
+ Disable user | +{"id":"USER ID"} |
+
| PUT | +/activate_user |
+ Activate User | +{"id":"USER ID"} |
+
| PUT | +/change_name |
+ Change username | +{"id":"USER ID","name":"NEW USERNAME"} |
+
| PUT | +/change_password |
+ Change user password | +{"id":"USER ID","password":"NEW SECURE PASSWORD"} |
+
Web Service Routes (more features still under development)
+ +++ +Note: Parameters can be changed during development!
+
List of routes for managing whatsapp:
+ + +All whatsapp connection wheels have a pattern of Headers of user (default, username = 'user', password = 'user').
+
+ The headers must be parameterized as :
+{
+ "Content-Type": "application/json",
+ "user": "user",
+ "user_pass": "user"
+}
+Using Webhook
+ +if you want to receive a callback on a specific url, pass the url parameter in the connect route.
+ +Methods POST
+ +| Type | +Route to browser | +Description | +Body | +
|---|---|---|---|
| POST | +/connect |
+ Start connection with Whatsapp | +{ "url": "http://localhost:8080/webhooktest" } |
+
| POST | +/sendtext |
+ Send a text to a number | +{ "to": "contact number", "body": "message"} |
+
| POST | +/sendFile |
+ Send file to a number | +{ "to": "contact number", "file_path": "https://docs.marklogic.com/guide/node-dev.pdf", "file_name": "node.js" } |
+
| POST | +/sendAudio |
+ Send audio | +{ "to": "contact number", "url_mp3": "https://cdn.freesound.org/previews/620/620094_4935038-lq.mp3", "file_name": "node.js" } |
+
| POST | +/sendImage |
+ Send image message | +{ "to": "contact number", "url_img": "https://i.pinimg.com/564x/a9/b1/18/a9b118761788b1ab260aae2835c468cd.jpg" } |
+
| POST | +/disconnect |
+ Disconnecting from the server | +EMPTY | +
| POST | +/check_user |
+ Check if the entered user exists | +EMPTY | +
Methods GET
+ +| Type | +Route to browser | +Description | +Body | +
|---|---|---|---|
| GET | +/get_all_contacts |
+ Retrieve contacts | +EMPTY |
+
| GET | +/check_connect |
+ check if the client is connected | +EMPTY |
+
| GET | +/last_qrcode |
+ Check if the QR-Code is active | +EMPTY |
+
| GET | +/screenshot |
+ Get screenshot | +EMPTY |
+
Basic send options functions (more features still under development)
+ +You must be logged in to use these functions!
+ +Here, to can be <phone Number>@c.us or <phone Number>-<groupId>@g.us or <phone Number><groupId>@g.us
+
+ you can send messages only using one function!
+// send text message
+await client
+ .sendMessage({
+ to: '0000000000@c.us', // you can pass the contact number or group number
+ body: 'A message sent by hydra-bot', // message text
+ options: {
+ type: 'sendText', // shipping type
+ },
+ })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// send files
+await client
+ .sendMessage({
+ to: '0000000000@c.us', // you can pass the contact number or group number
+ body: './file.pdf', // you can use a directory or use a url
+ options: {
+ type: 'sendFile', // shipping type
+ filename: 'filename', // put the file name here
+ },
+ })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// send file audio
+await client
+ .sendMessage({
+ to: '0000000000@c.us', // you can pass the contact number or group number
+ body: './file.mp3', // you can use a directory or use a url
+ options: {
+ type: 'sendAudio', // shipping type
+ },
+ })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Send audio file base64
+await client
+ .sendMessage({
+ to: '0000000000@c.us', // you can pass the contact number or group number
+ body: base64MP3, // you can use a directory or use a url
+ options: {
+ type: 'sendAudioBase64', // shipping type
+ },
+ })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Send image message
+await client
+ .sendMessage({
+ to: '0000000000@c.us', // you can pass the contact number or group number
+ body: './file.jpg', // you can use a directory or use a url
+ options: {
+ type: 'sendImage', // shipping type
+ caption: 'image text', // image text
+ },
+ })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Send image Base64
+await client
+ .sendMessage({
+ to: '0000000000@c.us', // you can pass the contact number or group number
+ body: base64IMG, // you can use a directory or use a url
+ options: {
+ type: 'sendImageFromBase64', // shipping type
+ caption: 'image text', // image text
+ },
+ })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+Basic send functions
+ +// Sends a text message to given chat
+await client
+ .sendText('0000000000@c.us', 'A message sent by hydra-bot')
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Sends file from path
+await client
+ .sendFile('0000000000@c.us', './file.pdf', { filename: 'filename' })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Send audio file
+await client
+ .sendAudio('0000000000@c.us', './file.mp3')
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Send audio base64
+await client
+ .sendAudioBase64('0000000000@c.us', base64MP3)
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Send image message
+await client
+ .sendImage('0000000000@c.us', './file.jpg', { caption: 'image text' })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Send image base64
+await client
+ .sendImageFromBase64('0000000000@c.us', base64IMG, { caption: 'image text' })
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+Profile Functions
+ +// Get device info
+await client.getHost();
+Retrieving Data
+ +// returns a list of contacts
+const contacts = await client.getAllContacts();
+
+// return whatsapp version
+const version = await client.getWAVersion();
+Group Management
+ +Group number example <phone Number>-<groupId>@g.us or <phone Number><groupId>@g.us
// Create group
+await client
+ .createGroup('Group name', ['111111111111@c.us', '222222222222@c.us'])
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Add participant to Group
+await client
+ .addParticipant('00000000-000000@g.us', [
+ '111111111111@c.us',
+ '222222222222@c.us',
+ ])
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Change group description
+await client
+ .setGroupDescription('00000000-000000@g.us', 'group description')
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+
+// Change group image
+await client
+ .setGroupImage('00000000000000@g.us', './file.jpg')
+ .then((result) => {
+ console.log(result); // message result
+ })
+ .catch((error) => {
+ console.log(error); // message error
+ });
+Events
+ +List of events triggered in the project
+
+// Event triggered when there's a change in the WhatsApp interface
+// The change information can include elements like screen changes or navigation.
+ev.on("interfaceChange", (change: any) => {
+ // Processes the interface change, like navigation between screens
+ console.log("Interface change detected:", change);
+});
+
+// Event triggered when a QR code is generated, typically used for authentication
+// The QR code is sent to the client as a string or object containing data for login.
+ev.on("qrcode", (qrcode) => {
+ // Displays the generated QR code for WhatsApp Web authentication
+ console.log("QR Code for authentication:", qrcode);
+});
+
+// Event triggered when there is a connection change, such as connection loss or establishment
+// Connection data may include network status or connection errors.
+ev.on('connection', async (conn) => {
+ // Displays information about the connection status
+ console.log("Connection status:", conn);
+ if (conn.connect) {
+ // Was connected to whatsapp chat
+ console.error("Has connected");
+ }
+});
+
+// Event triggered when a new message is received
+// The message may include data such as sender, content, timestamp, etc.
+ev.on("newMessage", (newMsg) => {
+ // Displays the data of the new received message
+ console.log("New message received:", newMsg);
+});
+
+// Event triggered when a message is edited
+// The edited message may include the previous content and the new content.
+ev.on("newEditMessage", async (editMessage) => {
+ // Processes the edited message by checking changes in content
+ console.log("Message edited:", editMessage);
+});
+
+// Event triggered when a message is deleted
+// The deleted message may include the message ID and other related details.
+ev.on("newDeleteMessage", async (deleteMessage) => {
+ // Processes the deletion of the message and notifies the user
+ console.log("Message deleted:", deleteMessage);
+});
+
+// Event triggered when there is a new intro reaction (emoji) to a message
+// This can be used to analyze which reactions were added to new messages.
+ev.on("onIntroReactionMessage", async (introReaction) => {
+ // Processes the intro reaction (emoji) to the new message
+ console.log("New intro reaction received:", introReaction);
+});
+
+// Event triggered when an emoji reaction is added to an existing message
+// The reaction may include details like the emoji, sender, and associated message.
+ev.on("onReactionMessage", async (reaction) => {
+ // Processes the reaction added to an existing message
+ console.log("Reaction added to message:", reaction);
+});
+
+// Event triggered to return the status of each message (e.g., read, delivered, etc.)
+// This can include data such as delivery and read status, allowing message state tracking.
+ev.on("newOnAck", async (event) => {
+ // Processes the acknowledgment status of the message
+ console.log("Message ack status:", event);
+});
+
+Debugging
+ +Building the hydra-bot is very simple
+ +Development
+ +To build the entire project just run
+> npm run build
+Test
+ +Run a test inside the project
+> npm run build:dev
+Maintainers
+ +Maintainers are needed, I cannot keep with all the updates by myself. If you are + interested please open a Pull Request.
+ +Contributing
+ +Pull requests are welcome. For major changes, please open an issue first to + discuss what you would like to change.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/CheckNumber.html b/interfaces/CheckNumber.html
new file mode 100644
index 0000000..5cf01b8
--- /dev/null
+++ b/interfaces/CheckNumber.html
@@ -0,0 +1,341 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface CheckNumber
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ number
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + CheckNumber + +
Index
+
+
+
+
+ Properties
+-
+
- connection +
- id +
- number
Exists
+ - status +
- text +
Properties
+connection
+ + +id
+ + +numberExists
+
+
+ status
+ + +text
+ + +
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/Contact.html b/interfaces/Contact.html
new file mode 100644
index 0000000..4d3107a
--- /dev/null
+++ b/interfaces/Contact.html
@@ -0,0 +1,523 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface Contact
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ display
+
+
+
+
+
+ formatted
+
+
+
+
+
+ formatted
+
+
+
+
+
+ formatted
+
+
+
+
+
+
+
+
+ is
+
+
+
+
+
+ is
+
+
+
+
+
+ is
+
+
+
+
+
+
+
+
+ is
+
+
+
+
+
+
+
+
+
+
+
+ mention
+
+
+
+
+
+
+
+
+ notify
+
+
+
+
+
+ profile
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Contact + +
Index
+
+
+
+
+ Properties
+-
+
- display
Name
+ - formatted
Name
+ - formatted
Short Name
+ - formatted
Short Name With Non Breaking Spaces
+ - id +
- is
Contact Sync Completed
+ - is
Me
+ - is
MyContact
+ - isPSA +
- is
User
+ - isWAContact +
- labels +
- mention
Name
+ - msg +
- notify
Name
+ - profile
Pic Thumb Obj
+ - pushname +
- type +
Properties
+displayName
+
+
+ formattedName
+
+
+ formattedShortName
+
+
+ formattedShortNameWithNonBreakingSpaces
+
+
+ id
+ + +isContactSyncCompleted
+
+
+ isMe
+
+
+ isMyContact
+
+
+ isPSA
+ + +isUser
+
+
+ isWAContact
+ + +labels
+ + +mentionName
+
+
+ msg
+ + +notifyName
+
+
+ profilePicThumbObj
+
+
+ pushname
+ + +type
+ + +
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/CreateOptions.html b/interfaces/CreateOptions.html
new file mode 100644
index 0000000..db6e18f
--- /dev/null
+++ b/interfaces/CreateOptions.html
@@ -0,0 +1,441 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface CreateOptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional mkdir
+
+
+
+
+
+ Optional path
+
+
+
+
+
+ Optional printQRIn
+
+
+
+
+
+ Optional puppeteer
+
+
+
+
+
+
+
+
+ Optional time
+
+
+
+
+
+ Optional updates
+
+
+
+
+
+
+
+
+
+
+ initial function optional parameters
+Hierarchy
+-
+
- + CreateOptions + +
Index
+
+
+
+
+ Properties
+ +Properties
+Optional mkdirFolderToken
+
+
+
+
+
+
+
+ token folder path, only inside the project
+Optional pathNameToken
+
+
+
+
+
+
+
+ the path and name of the folder where the client tokens will be saved
+Optional printQRInTerminal
+
+
+
+
+
+
+
+ the QR CODE will be printed on the terminal
+Optional puppeteerOptions
+
+
+
+
+
+
+ puppeteer Options
+Optional session
+ + +
+
+
+
+
+ name of the token to be generated, a folder with all customer information will be created
+Optional timeAutoClose
+
+
+
+
+
+
+
+ if you don't read the QR CODE by default 60 seconds, it will automatically close the client's browser to save memory, if you want to disable it, set 0 or false
+Optional updatesLog
+
+
+
+
+
+
+
+ logs info updates automatically in terminal
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/CreateSize.html b/interfaces/CreateSize.html
new file mode 100644
index 0000000..0e4ba57
--- /dev/null
+++ b/interfaces/CreateSize.html
@@ -0,0 +1,299 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface CreateSize
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/Id.html b/interfaces/Id.html
new file mode 100644
index 0000000..6158702
--- /dev/null
+++ b/interfaces/Id.html
@@ -0,0 +1,313 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface Id
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Id + +
Index
+
+
+
+
+ Properties
+-
+
- _serialized +
- server +
- user +
Properties
+_serialized
+ + +server
+ + +user
+ + +
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/IdMessage.html b/interfaces/IdMessage.html
new file mode 100644
index 0000000..474ab4c
--- /dev/null
+++ b/interfaces/IdMessage.html
@@ -0,0 +1,313 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface IdMessage
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + IdMessage + +
Index
+
+
+
+
+ Properties
+-
+
- _serialized +
- id +
- remote +
Properties
+_serialized
+ + +id
+ + +remote
+ + +
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/InterfaceHost.html b/interfaces/InterfaceHost.html
new file mode 100644
index 0000000..e18e8b9
--- /dev/null
+++ b/interfaces/InterfaceHost.html
@@ -0,0 +1,775 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface InterfaceHost
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ business
+
+
+
+
+
+
+
+
+ cover
+
+
+
+
+
+ custom
+
+
+
+
+
+ custom
+
+
+
+
+
+
+
+
+ direct
+
+
+
+
+
+ display
+
+
+
+
+
+ email
+ + +
+
+
+
+
+
+ eurl
+
+
+
+
+
+ fb
+
+
+
+
+
+ formatted
+
+
+
+
+
+ formatted
+
+
+
+
+
+
+
+
+ ig
+
+
+
+
+
+ is
+
+
+
+
+
+ is
+
+
+
+
+
+
+
+
+ legal
+
+
+
+
+
+
+
+
+ notify
+
+
+
+
+
+ pending
+
+
+
+
+
+ preview
+
+
+
+
+
+ profile
+
+
+
+
+
+
+
+
+
+
+
+ search
+
+
+
+
+
+
+
+
+ status
+
+
+
+
+
+ structured
+
+
+
+
+
+
+
+
+
+
+
+ verified
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + InterfaceHost + +
Index
+
+
+
+
+ Properties
+-
+
- address +
- business
Hours
+ - categories +
- cover
Photo
+ - custom
Url Path
+ - custom
Url Paths
+ - description +
- direct
Connection
+ - display
Name
+ - eurl +
- eurl
Stale
+ - fb
Page
+ - formatted
Title
+ - formatted
User
+ - id +
- ig
Professional
+ - is
Business
+ - is
Profile Linked
+ - latitude +
- legal
Entity Details
+ - longitude +
- notify
Name
+ - pending
Pic
+ - preview
Eurl
+ - profile
Options
+ - pushname +
- raw +
- search
Name
+ - stale +
- status
Connection
+ - structured
Address
+ - tag +
- timestamp +
- verified
Name
+ - website +
Properties
+address
+ + +businessHours
+
+
+ categories
+ + +coverPhoto
+
+
+ customUrlPath
+
+
+ customUrlPaths
+
+
+ description
+ + +directConnection
+
+
+ displayName
+
+
+ eurl
+ + +eurlStale
+
+
+ fbPage
+
+
+ formattedTitle
+
+
+ formattedUser
+
+
+ id
+ + +igProfessional
+
+
+ isBusiness
+
+
+ isProfileLinked
+
+
+ latitude
+ + +legalEntityDetails
+
+
+ longitude
+ + +notifyName
+
+
+ pendingPic
+
+
+ previewEurl
+
+
+ profileOptions
+
+
+ pushname
+ + +raw
+ + +searchName
+
+
+ stale
+ + +statusConnection
+
+
+ structuredAddress
+
+
+ tag
+ + +timestamp
+ + +verifiedName
+
+
+ website
+ + +
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/InterfaceQrcode.html b/interfaces/InterfaceQrcode.html
new file mode 100644
index 0000000..8ba08e3
--- /dev/null
+++ b/interfaces/InterfaceQrcode.html
@@ -0,0 +1,355 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface InterfaceQrcode
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/InterfaceScope.html b/interfaces/InterfaceScope.html
new file mode 100644
index 0000000..17b2ca0
--- /dev/null
+++ b/interfaces/InterfaceScope.html
@@ -0,0 +1,355 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface InterfaceScope
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/PuppeteerOptions.html b/interfaces/PuppeteerOptions.html
new file mode 100644
index 0000000..31e777c
--- /dev/null
+++ b/interfaces/PuppeteerOptions.html
@@ -0,0 +1,454 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface PuppeteerOptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional chromium
+
+
+
+
+
+
+
+
+ Optional download
+
+
+
+
+
+ Optional executable
+
+
+
+
+
+
+
+
+
+
+
+ Optional user
+
+
+
+
+
+
+ Hierarchy
+-
+
- + PuppeteerOptions + +
Index
+
+
+
+
+ Properties
+-
+
- args +
- chromium
Version
+ - devtools +
- download
Chromium
+ - executable
Path
+ - headless +
- ignoreHTTPSErrors +
- user
Data Dir
+
Properties
+Optional args
+ + +
+
+
+
+
+ additional arguments to pass to the browser instance. adding any parameter you will replace the default args of the project
+Optional chromiumVersion
+
+
+
+
+
+
+
+ chromium version the project should use
+Optional devtools
+ + +
+
+
+ Optional downloadChromium
+
+
+
+
+
+
+
+ when started, the project will automatically download Chromium if it can't find it
+Optional executablePath
+
+
+
+
+
+
+
+ the browser that will be used for the project, you can specify a path, if you don't pass any parameters it will open the installed browser.
+Optional headless
+ + +
+
+
+
+
+ specify whether the browser is visible or invisible, invisible to true and visible to false
+Optional ignoreHTTPSErrors
+ + +
+
+
+ Optional userDataDir
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/ReactionIntro.html b/interfaces/ReactionIntro.html
new file mode 100644
index 0000000..133e487
--- /dev/null
+++ b/interfaces/ReactionIntro.html
@@ -0,0 +1,341 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface ReactionIntro
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reaction
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + ReactionIntro + +
Index
+
+
+
+
+ Properties
+-
+
- id +
- index +
- reaction
ByMe
+ - senders +
- type +
Properties
+id
+ + +index
+ + +reactionByMe
+
+
+ senders
+ + +type
+ + +
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/SendOptions.html b/interfaces/SendOptions.html
new file mode 100644
index 0000000..0314919
--- /dev/null
+++ b/interfaces/SendOptions.html
@@ -0,0 +1,313 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface SendOptions
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/StatusFind.html b/interfaces/StatusFind.html
new file mode 100644
index 0000000..76bfa8c
--- /dev/null
+++ b/interfaces/StatusFind.html
@@ -0,0 +1,439 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface StatusFind
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ base64
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ on
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ status
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + StatusFind + +
Index
+Properties
+base64Image
+
+
+ client
+ + +connect
+ + +erro
+ + +onType
+
+
+ page
+ + +qrcode
+ + +result
+ + +session
+ + +status
+ + +statusFind
+
+
+ text
+ + +
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/interfaceChange.html b/interfaces/interfaceChange.html
new file mode 100644
index 0000000..820f28c
--- /dev/null
+++ b/interfaces/interfaceChange.html
@@ -0,0 +1,313 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Interface interfaceChange
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules.html b/modules.html
new file mode 100644
index 0000000..2b8c304
--- /dev/null
+++ b/modules.html
@@ -0,0 +1,362 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+ hydra-bot - v1.0.33
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const default
+
+
+
+
+
+
+
+ init
+
+
+
+ init
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+
+
+
+
+ Enumerations
+-
+
- Function
Type
+ - Interface
Mode
+ - On
Mode
+ - Reaction
Type
+ - Type
Status Find
+
Classes
+-
+
- Callback
OnStatus
+ - Group
Layer
+ - Listener
Layer
+ - On
Mod
+ - Retriever
Layer
+ - Scraping +
- Sender
Layer
+ - Web
Pack
+
Interfaces
+-
+
- Check
Number
+ - Contact +
- Create
Options
+ - Create
Size
+ - Id +
- Id
Message
+ - Interface
Host
+ - Interface
Qrcode
+ - Interface
Scope
+ - Puppeteer
Options
+ - Reaction
Intro
+ - Send
Options
+ - Status
Find
+ - interface
Change
+
Variables
+-
+
- default
Config
+
Functions
+-
+
- init
Server
+ - init
Ws
+
Variables
+Const defaultConfig
+
+
+ Functions
+initServer
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional createOption: CreateOptions
+
+
Returns Promise<WebPack | any>
+
+ -
+
initWs
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional createOption: CreateOptions | options
+
+
Returns Promise<any>
+
+ -
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/Getting Started/installation.html b/pages/Getting Started/installation.html
new file mode 100644
index 0000000..26407d7
--- /dev/null
+++ b/pages/Getting Started/installation.html
@@ -0,0 +1,209 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Installation
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+ +The Hydra-Bot Project is an open-source application developed entirely in TypeScript and Node.js. To use it, it is essential to have Node.js installed in your environment, as it is responsible for running the application's code. Additionally, you will need npm (Node.js package manager) to download and manage the dependencies necessary for the project to work.
+You can download Node.js, which includes npm, directly from the official website: + Download Node.js and npm
+ +Verifying the Installations
+ +To ensure that Node.js and npm are correctly installed, you can run the following commands in your terminal to check their versions:
+To check the Node.js version:
+node -v
+This command will display the installed Node.js version. + To check the npm version:
+npm -v
+This command will display the installed npm version.
+ +What is npm?
+ +npm is the default package manager for the Node.js JavaScript runtime environment. It is used to download and manage libraries, including the latest version of Hydra-Bot, for your machine.
+ +Installing Hydra-Bot
+ + +Unstable Version
+ +You can install the latest version of Hydra-Bot directly via npm using the following command:
+npm i --save hydra-bot
+Development Version
+ +If you want access to the current development version (beta), which includes features not yet officially released, you can download it from GitHub with the following command:
+npm i --save https://github.com/jonalan7/Hydra-bot/releases/download/nightly/hydra-nightly.tgz
+Hydra-Bot Operation Modes
+ + +Free Mode
+ +In this mode, you have complete freedom to create your custom automations. + You can leverage the full power of Node.js to program and configure the functionalities as you wish.
+ + +Web-Service Mode
+ +This mode is ideal for those less familiar with Node.js or those who prefer using predefined operations. + It provides a set of ready-to-use routes utilizing the HTTP methods POST, GET, PUT, and DELETE, allowing for simple and efficient interaction with the system.
+ +
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/Getting Started/start_bot.html b/pages/Getting Started/start_bot.html
new file mode 100644
index 0000000..8a81c51
--- /dev/null
+++ b/pages/Getting Started/start_bot.html
@@ -0,0 +1,232 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Start Bot
+
+
+
+
+
+
+
+
+
+
+
+ Getting started bot (the bot in raw form, without using a Web Services).
+ +If you want to work in free mode, using only the bot, dry the necessary information!
+
+const hydraBot = require('hydra-bot');
+
+(async () => {
+ let client;
+ // start bot service
+ const ev = await hydraBot.initServer();
+
+ // return to current whatsapp interface
+ ev.on('interfaceChange', (change) => {
+ console.log("interfaceChange: ", change);
+ });
+
+ // return qrcode parameters
+ ev.on('qrcode', (qrcode) => {
+ console.log('qrcode: ', qrcode);
+ });
+
+ // return connection information
+ ev.on('connection', async (conn) => {
+
+ // browser information!
+ if (conn.statusFind === 'browser') {
+ console.log('info Browser: ', conn.text);
+ }
+
+ // Was connected to whatsapp chat
+ if (conn.connect) {
+ client = conn.client; // class client from hydra-bot
+ const getMe = await client.getHost();
+ const hostNumber = getMe.id._serialized; // number host
+ console.log('Host Number: ', hostNumber);
+ // send a text message
+ await client.sendMessage({
+ to: hostNumber, // you can pass the contact number or group number
+ body: "hi i'm hydra bot", // message text
+ options: {
+ type: 'sendText', // shipping type
+ }
+ }).then((result) => {
+ console.log(result); // message result
+ }).catch((error) => {
+ console.log(error); // message error
+ });
+
+ }
+ });
+
+ ev.on('newMessage', async (newMsg) => {
+ // when is received
+ if (!newMsg.result.fromMe) {
+ // message received!
+ console.log('NewMessageReceived: ', newMsg.result);
+ }
+ // when is it sent
+ if (!!newMsg.result.fromMe) {
+ // Message sent
+ console.log('NewMessageSent: ', newMsg.result);
+ }
+ });
+
+ // returns the status of each message
+ ev.on('newOnAck', async (event) => {
+ console.log('id Message: ', event.result.id._serialized); // message id
+ console.log('Status Message: ', event.result.ack); // -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
+ console.log('From Message: ', event.result.from); // from message
+ console.log('To Message: ', event.result.to); // to message
+ });
+
+})();
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/Getting Started/web_service.html b/pages/Getting Started/web_service.html
new file mode 100644
index 0000000..f49c464
--- /dev/null
+++ b/pages/Getting Started/web_service.html
@@ -0,0 +1,194 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Web service
+
+
+
+
+
+
+
+
+
+
+
+ Features and Capabilities
+ +-
+
- Customizable Web Service: The
hydra-botlibrary allows you to tailor the service's behavior to fit your application requirements.
+ - Easy Integration: Simplified initialization with robust webhook support for client applications. +
- Scalable Administration: Terminal commands provide a straightforward way to manage the service. +
Getting Started: Web Service
+ +The web service will run locally on localhost using port 8080. Below is an example of how to initialize the service:
const hydraBot = require('hydra-bot');
+
+(async () => {
+ // Initialize and start the Web Service
+ const WS = await hydraBot.initWs();
+})();
+Commands for administration via terminal
+ +The Web Service includes commands for administration and control directly through the terminal. These commands allow administrators to manage and monitor the service effectively.
+For a complete guide to terminal administration, visit: + Terminal Administration Guide
+ +Using the Client Webhook
+ +The service also supports webhook integration for client-side interaction. This feature allows external systems to send and receive real-time data, enabling seamless automation and communication.
+For more information on how to use the client webhook, check out the guide: + Client Webhook Usage Guide
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/Getting Started/web_service/admin.html b/pages/Getting Started/web_service/admin.html
new file mode 100644
index 0000000..0978ee4
--- /dev/null
+++ b/pages/Getting Started/web_service/admin.html
@@ -0,0 +1,342 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Administration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Example Postman
+ +Use Postman to test the routes! + Postman example + Download Postman
+ +Commands for administration via terminal
+ +To start the administration interface, run the following command in the terminal:
+> yarn admin
+Install yarn Ubuntu:
+> curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+> echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+> sudo apt update && sudo apt install yarn
+> yarn
+what is an administrator for?
+ +Administrators are responsible for managing API users via Webhook. They can execute commands that allow creating, deleting, and managing user data.
+ +Available Commands in the Terminal for Administration:
+ +Here is the list of commands an administrator can use in the terminal to manage users:
+| Command | +Description | +
|---|---|
/create |
+ Create a new user | +
/delete |
+ Delete an existing user | +
/selectid |
+ Show a user by ID | +
/selectname |
+ Show a user by name | +
/getall |
+ List all users | +
/deactivate |
+ Disable user | +
/activate |
+ Activate User | +
/changename |
+ Change a user's name | +
/password |
+ Change a user's password | +
/cls |
+ Clear screen/terminal | +
/help |
+ List all available commands for administration | +
/exit |
+ Exit the administration manager | +
Administration via Webhook
+ +These routes allow you to manage and query users using a REST API. An administrator can access these routes by authenticating with a specific header that includes the admin credentials.
+To authenticate requests via Webhook, you need to include the following headers in the request:
+{
+ "Content-Type" : "application/json",
+ "admin" : "admin",
+ "admin_pass" : "admin"
+}
+List of Routes for User Management:
+ +With an administrator (there is a default administrator, the username and password as admin), he can access via Web Service with the following routes:
+| Type | +Route to browser | +Description | +Body | +
|---|---|---|---|
| POST | +/create_user |
+ Create user | +{"name":"USE","password":"USER PASSWORD"} |
+
| DEL | +/delete_user/ID_USE |
+ Delete user | +EMPTY |
+
| GET | +/get_user_by_id/ID_USE |
+ Show user by ID | +EMPTY |
+
| GET | +/get_all_users |
+ List all users | +EMPTY |
+
| PUT | +/deactivate_user |
+ Disable user | +{"id":"USER ID"} |
+
| PUT | +/activate_user |
+ Activate User | +{"id":"USER ID"} |
+
| PUT | +/change_name |
+ Change username | +{"id":"USER ID","name":"NEW USERNAME"} |
+
| PUT | +/change_password |
+ Change user password | +{"id":"USER ID","password":"NEW SECURE PASSWORD"} |
+
How to Use the Routes:
+ +-
+
POST
+/create_user: This route creates a new user. Send a JSON body containing the name and password of the user you want to create.
+ DELETE
+/delete_user/USER_ID: This route deletes a specific user by their USER_ID. No body is required in the request.
+ GET
+/get_user_by_id/USER_ID: To retrieve a user by their ID, send a GET request. No body is required.
+ GET
+/get_all_users: This route lists all users. No body is required in the request.
+ PUT
+/deactivate_user: To deactivate a user, send a JSON body containing the USER_ID of the user you want to disable.
+ PUT
+/activate_user: This route activates a disabled user. Send the USER_ID in the request body.
+ PUT
+/change_name: To change a user's name, send the USER_ID and the new name in the request body.
+ PUT
+/change_password: This route changes a user's password. Send the USER_ID and the new password in the request body.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/Getting Started/web_service/user.html b/pages/Getting Started/web_service/user.html
new file mode 100644
index 0000000..0a27231
--- /dev/null
+++ b/pages/Getting Started/web_service/user.html
@@ -0,0 +1,280 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ User Routers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Example Postman
+ +Use Postman to test routes! + Postman example + Download Postman
+ +List of routes for managing whatsapp:
+ +All whatsapp connection wheels have a pattern of Headers of user.
+ The headers must be parameterized as :
{
+ "Content-Type" : "application/json",
+ "user" : "user",
+ "user_pass" : "user"
+}
+Summary
+ +-
+
- Methods POST +
- Methods GET +
Using Webhook
+ +if you want to receive a callback on a specific url, pass the url parameter in the connect route.
+ +Methods POST
+ +| Type | +Route to browser | +Description | +Body | +
|---|---|---|---|
| POST | +/connect |
+ Start connection with Whatsapp | +{ "url": "http://localhost:8080/webhooktest" } |
+
| POST | +/sendtext |
+ Send a text to a number | +{ "to": "contact number", "body": "message"} |
+
| POST | +/sendFile |
+ Send file to a number | +{ "to": "contact number", "file_path": "https://docs.marklogic.com/guide/node-dev.pdf", "file_name": "node.js" } |
+
| POST | +/sendAudio |
+ Send audio | +{ "to": "contact number", "url_mp3": "https://cdn.freesound.org/previews/620/620094_4935038-lq.mp3" } |
+
| POST | +/sendImage |
+ Send image message | +{ "to": "contact number", "url_img": "https://i.pinimg.com/564x/a9/b1/18/a9b118761788b1ab260aae2835c468cd.jpg" } |
+
| POST | +/disconnect |
+ Disconnecting from the server | +EMPTY | +
| POST | +/check_user |
+ Check if the entered user exists | +EMPTY | +
Methods GET
+ +| Type | +Route to browser | +Description | +Body | +
|---|---|---|---|
| GET | +/get_all_contacts |
+ Retrieve contacts | +EMPTY |
+
| GET | +/check_connect |
+ check if the client is connected | +EMPTY |
+
| GET | +/last_qrcode |
+ Check if the QR-Code is active | +EMPTY |
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/How To/events.html b/pages/How To/events.html
new file mode 100644
index 0000000..e461e9d
--- /dev/null
+++ b/pages/How To/events.html
@@ -0,0 +1,261 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Events
+
+
+
+
+
+
+
+
+
+
+ Here,
+
+
+ Group Functions
+ + +Here, to can be <phone Number>@c.us, <phone Number>-<groupId>@g.us, or <phone Number><groupId>@g.us.
+
+ To use these functions, it is necessary to initialize the bot.
Click here to learn more.
Summary
+ +-
+
- interfaceChange +
- qrcode +
- connection +
- newEditMessage +
- newDeleteMessage +
- onIntroReactionMessage +
- onReactionMessage +
- newOnAck +
interfaceChange
+ +Event triggered when there's a change in the WhatsApp interface
+// The change information can include elements like screen changes or navigation.
+ev.on("interfaceChange", (change: any) => {
+ // Processes the interface change, like navigation between screens
+ console.log("Interface change detected:", change);
+});
+qrcode
+ +Event triggered when a QR code is generated, typically used for authentication
+// The QR code is sent to the client as a string or object containing data for login.
+ev.on("qrcode", (qrcode) => {
+ // Displays the generated QR code for WhatsApp Web authentication
+ console.log("QR Code for authentication:", qrcode);
+});
+connection
+ +Event triggered when there is a connection change, such as connection loss or establishment
+// Connection data may include network status or connection errors.
+ev.on('connection', async (conn) => {
+ // Displays information about the connection status
+ console.log("Connection status:", conn);
+ if (conn.connect) {
+ // Was connected to whatsapp chat
+ console.error("Has connected");
+ }
+});
+newEditMessage
+ +Event triggered when a message is edited
+// The edited message may include the previous content and the new content.
+ev.on("newEditMessage", async (editMessage) => {
+ // Processes the edited message by checking changes in content
+ console.log("Message edited:", editMessage);
+});
+newDeleteMessage
+ +Event triggered when a message is deleted
+// The deleted message may include the message ID and other related details.
+ev.on("newDeleteMessage", async (deleteMessage) => {
+ // Processes the deletion of the message and notifies the user
+ console.log("Message deleted:", deleteMessage);
+});
+onIntroReactionMessage
+ +Event triggered when there is a new intro reaction (emoji) to a message
+// This can be used to analyze which reactions were added to new messages.
+ev.on("onIntroReactionMessage", async (introReaction) => {
+ // Processes the intro reaction (emoji) to the new message
+ console.log("New intro reaction received:", introReaction);
+});
+onReactionMessage
+ +Event triggered when an emoji reaction is added to an existing message
+// The reaction may include details like the emoji, sender, and associated message.
+ev.on("onReactionMessage", async (reaction) => {
+ // Processes the reaction added to an existing message
+ console.log("Reaction added to message:", reaction);
+});
+newOnAck
+ +Event triggered to return the status of each message (e.g., read, delivered, etc.)
+// This can include data such as delivery and read status, allowing message state tracking.
+ev.on("newOnAck", async (event) => {
+ // Processes the acknowledgment status of the message
+ console.log("Message ack status:", event);
+});
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/How To/profile_functions.html b/pages/How To/profile_functions.html
new file mode 100644
index 0000000..01eb15d
--- /dev/null
+++ b/pages/How To/profile_functions.html
@@ -0,0 +1,187 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Profile Functions
+
+
+
+
+
+
+
+
+
+
+ Here,
+
+
+ Profile Functions
+ + +Here, to can be <phone Number>@c.us, <phone Number>-<groupId>@g.us, or <phone Number><groupId>@g.us.
+
+ To use these functions, it is necessary to initialize the bot.
Click here to learn more.
Summary
+ +-
+
- getHost +
- getWAVersion +
getHost
+ +Retrieve information about the device connected to the bot.
+
+await client.getHost();
+
+getWAVersion
+ +Retrieve the version of WhatsApp currently in use.
+
+const version = await client.getWAVersion();
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/How To/retrieving_data.html b/pages/How To/retrieving_data.html
new file mode 100644
index 0000000..b37e087
--- /dev/null
+++ b/pages/How To/retrieving_data.html
@@ -0,0 +1,184 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Retrieving Data
+
+
+
+
+
+
+
+
+
+
+ Here,
+
+
+ Retrieving Data
+ +data reception functions
+ +Here, to can be <phone Number>@c.us, <phone Number>-<groupId>@g.us, or <phone Number><groupId>@g.us.
+
+ To use these functions, it is necessary to initialize the bot.
Click here to learn more.
Summary
+ +-
+
- getAllContacts +
- checkNumber +
getAllContacts
+ +Returns a list of contacts
+const contacts = await client.getAllContacts();
+checkNumber
+ +Check if the number exists
+const result = await client.checkNumber("<phone Number>@c.us");
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/How To/send_functions.html b/pages/How To/send_functions.html
new file mode 100644
index 0000000..6e11042
--- /dev/null
+++ b/pages/How To/send_functions.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Send Messages
+
+
+
+
+
+
+
+
+
+
+ Here,
+
+
+ Basic send functions
+ + +Here, to can be <phone Number>@c.us, <phone Number>-<groupId>@g.us, or <phone Number><groupId>@g.us.
+
+ To use these functions, it is necessary to initialize the bot.
Click here to learn more.
Send messages separately
+ +Summary
+ +-
+
- sendText +
- sendFile +
- sendAudio +
- sendAudioBase64 +
- sendImage +
- sendImageFromBase64 +
sendText
+ +Sends a text message to given chat
+await client.sendText("0000000000@c.us", "A message sent by hydra-bot")
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendFile
+ +Sends file from path
+await client.sendFile("0000000000@c.us", './file.pdf', { filename: 'filename' })
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendAudio
+ +Send audio file
+await client.sendAudio("0000000000@c.us", './file.mp3')
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendAudioBase64
+ +Send audio base64
+await client.sendAudioBase64("0000000000@c.us", base64MP3)
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendImage
+ +Send image message
+await client.sendImage("0000000000@c.us", './file.jpg', { caption: 'image text' })
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendImageFromBase64
+ +Send image base64
+await client.sendImageFromBase64("0000000000@c.us", base64IMG, { caption: 'image text' })
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/How To/send_options.html b/pages/How To/send_options.html
new file mode 100644
index 0000000..5b35677
--- /dev/null
+++ b/pages/How To/send_options.html
@@ -0,0 +1,275 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Send Messages Options
+
+
+
+
+
+
+
+
+
+
+ Here,
+
+
+ Basic send options functions
+ + +Here, to can be <phone Number>@c.us, <phone Number>-<groupId>@g.us, or <phone Number><groupId>@g.us.
+
+ To use these functions, it is necessary to initialize the bot.
Click here to learn more.
you can send messages only using one function!
+ +Summary
+ +-
+
- sendText +
- sendFile +
- sendAudio +
- sendAudioBase64 +
- sendImage +
- sendImageFromBase64 +
sendText
+ +// send text message
+await client.sendMessage({
+ to: "0000000000@c.us", // you can pass the contact number or group number
+ body: "A message sent by hydra-bot", // message text
+ options: {
+ type: 'sendText', // shipping type
+ }
+}).then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendFile
+ +// send text message
+await client.sendMessage({
+ to: "0000000000@c.us", // you can pass the contact number or group number
+ body: './file.pdf', // you can use a directory or use a url
+ options: {
+ type: 'sendFile', // shipping type
+ filename: 'filename' // put the file name here
+ }
+}).then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendAudio
+ +// send file audio
+await client.sendMessage({
+ to: "0000000000@c.us", // you can pass the contact number or group number
+ body: './file.mp3', // you can use a directory or use a url
+ options: {
+ type: 'sendAudio', // shipping type
+ }
+}).then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendAudioBase64
+ +// Send audio file base64
+await client.sendMessage({
+ to: "0000000000@c.us", // you can pass the contact number or group number
+ body: base64MP3, // you can use a directory or use a url
+ options: {
+ type: 'sendAudioBase64', // shipping type
+ }
+}).then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendImage
+ +// Send image message
+await client.sendMessage({
+ to: "0000000000@c.us", // you can pass the contact number or group number
+ body: './file.jpg', // you can use a directory or use a url
+ options: {
+ type: 'sendImage', // shipping type
+ caption: 'image text' // image text
+ }
+}).then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+sendImageFromBase64
+ +// Send image Base64
+await client.sendMessage({
+ to: "0000000000@c.us", // you can pass the contact number or group number
+ body: base64IMG, // you can use a directory or use a url
+ options: {
+ type: 'sendImageFromBase64', // shipping type
+ caption: 'image text' // image text
+ }
+}).then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/Management/downloading_files.html b/pages/Management/downloading_files.html
new file mode 100644
index 0000000..0a03e07
--- /dev/null
+++ b/pages/Management/downloading_files.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Downloading Files
+
+
+
+
+
+
+
+
+
+
+
+ Downloading Files
+ +Puppeteer takes care of the file downloading. The decryption is being done as fast as possible (outruns native methods). Supports big files!
+const hydraBot = require('hydra-bot');
+const fs = require('fs');
+const mime = require('mime-types');
+
+(async () => {
+ let client;
+ // start bot service
+ const ev = await hydraBot.initServer();
+ // return connection information
+ ev.on('connection', async (conn) => {
+ // Was connected to whatsapp chat
+ if (conn.connect) {
+ client = conn.client;
+ }
+ });
+ ev.on('newMessage', async (newMsg) => {
+ // when is received
+ if (!newMsg.result.fromMe) {
+ // message received!
+ console.log('NewMessageReceived: ', newMsg.result);
+ // dowload files
+ if (newMsg.result.isMedia) {
+ const buffer = await client.decryptFile(newMsg.result);
+ // 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(newMsg.result.mimetype)}`;
+ fs.writeFile(fileName, buffer, (err) => {
+ if (err) {
+ console.log(err);
+ }
+ });
+ }
+ }
+ });
+})();
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pages/Management/group_functions.html b/pages/Management/group_functions.html
new file mode 100644
index 0000000..0d6a62b
--- /dev/null
+++ b/pages/Management/group_functions.html
@@ -0,0 +1,217 @@
+
+
+
+
+
+ Generated using TypeDoc
+
+
+
+
+
+ Group Management
+
+
+
+
+
+
+
+
+
+
+ Here,
+
+
+ Group Functions
+ + +Here, to can be <phone Number>@c.us, <phone Number>-<groupId>@g.us, or <phone Number><groupId>@g.us.
+
+ To use these functions, it is necessary to initialize the bot.
Click here to learn more.
Summary
+ + + +createGroup
+ +Create group
+await client.createGroup('Group name', ['111111111111@c.us', '222222222222@c.us'])
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+addParticipant
+ +Add participant
+await client.addParticipant('00000000-000000@g.us', ['111111111111@c.us', '222222222222@c.us'])
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+setGroupDescription
+ +Change group description
+await client.setGroupDescription('00000000-000000@g.us', 'group description')
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+setGroupImage
+ +Change group image
+await client.setGroupImage('00000000000000@g.us', './file.jpg')
+.then((result) => {
+ console.log(result); // message result
+}).catch((error) => {
+ console.log(error); // message error
+});
+
+
+
+
+
+
\ No newline at end of file
Generated using TypeDoc
+
Attribution and behavior change of a given event
+