Skip to content

The full list of the library methods#

Method Description Documentation
account.getSettings() The method is used to get the current instance settings GetSettings
account.setSettings() The method is used to set an instance settings SetSettings
account.getStateInstance() The method is used to get the instance state GetStateInstance
account.getStatusInstance() The method is used to get the status of the instance socket connection with WhatsApp GetStatusInstance
account.reboot() The method is used to reboot an instance Reboot
account.logout() The method is used to log out an instance Logout
account.qr() The method is used to get QR code QR
account.getAuthorizationCode() The method is used to authorize an instance by phone number GetAuthorizationCode
account.setProfilePicture() The method is used to set an account picture SetProfilePicture
device.getDeviceInfo() The method is used to get information about the device (phone) running WhatsApp Business application GetDeviceInfo
groups.createGroup() The method is used to add a participant to a group chat. IMPORTANT: If one tries to create a group with a non-existent number, WhatsApp may block the sender's number. CreateGroup
groups.updateGroupName() The method is used to change a group chat name UpdateGroupName
groups.getGroupData() The method is used to get group chat data GetGroupData
groups.addGroupParticipant() The method is used to add a participant to a group chat AddGroupParticipant
groups.removeGroupParticipant() The method is used to remove a participant from a group chat RemoveGroupParticipant
groups.setGroupAdmin() The method is used to set a group chat participant as an administrator SetGroupAdmin
groups.removeAdmin() The method is used to remove a participant from group chat administartion rights RemoveAdmin
groups.setGroupPicture() The method is used to set a group picture SetGroupPicture
groups.leaveGroup() The method is used to make the current account user leave the group chat LeaveGroup
journals.getChatHistory() The method is used to get the chat message history GetChatHistory
journals.getMessage() The method is used to get the chat message GetMessage
journals.lastIncomingMessages() The method is used to get the last incoming messages of the account. In the default mode the incoming messages for 24 hours are returned LastIncomingMessages
journals.lastOutgoingMessages() The method is used to get the last outgoing messages of the account. In the default mode the last messages for 24 hours are returned LastOutgoingMessages
queues.showMessagesQueue() The method is used to get a list of messages in the queue to be sent ShowMessagesQueue
queues.slearMessagesQueue() The method is used to clear the queue of messages to be sent ClearMessagesQueue
readMark.readChat() The method is used to mark messages in a chat as read. Either all messages or a specified message in a chat can be marked as read ReadChat
receiving.receiveNotification() The method is used to receive one incoming notification from the notifications queue ReceiveNotification
receiving.deleteNotification() The method is used to delete an incoming notification from the notification queue DeleteNotification
receiving.downloadFile() The method is used to download incoming and outgoing files DownloadFile
sending.sendMessage() The method is used to send a text message to a personal or a group chat SendMessage
sending.sendButtons() The method is used to send a button message to a personal or a group chat SendButtons
sending.sendTemplateButtons() The method is used to send a message with template list interacrive buttons to a personal or a group chat SendTemplateButtons
sending.sendPoll() The method is used to sending a poll a personal or a group chat SendPoll
sending.sendListMessage() The method is used to send a message with a select button from a list of values to a personal or a group chat SendListMessage
sending.sendFileByUpload() The method is used to send a file uploaded by form (form-data) SendFileByUpload
sending.sendFileByUrl() The method is used to send a file uploaded by Url SendFileByUrl
sending.uploadFile() The method is used to upload a file to the cloud storage, which can be sent using the sendFileByUrl method UploadFile
sending.sendLocation() The method is used to send a location message SendLocation
sending.sendContact() The method is used to send a contact message SendContact
sending.sendLink() The method is used to send a message with a link, by which an image preview, title and description will be added (deprecated) SendLink
sending.forwardMessages() The method is intended for forwarding messages to a personal or group chat ForwardMessages
service.checkWhatsapp() The method is used to check WhatsApp account availability on a phone number CheckWhatsapp
service.getAvatar() The method is used to return a user or a group chat avatar GetAvatar
service.getContacts() The method is used to get a list of the current account contacts GetContacts
service.getContactInfo() The method is used to get information on a contact GetContactInfo
service.editMessage() The method is edit the text message in a chat. EditMessage
service.deleteMessage() The method is used to delete a message from a chat DeleteMessage
service.archiveChat() The method is used to archive a chat. One can archive chats that have at least one incoming message ArchiveChat
service.unarchiveChat() The method is used to unarchive a chat UnarchiveChat
service.setDisappearingChat() The method is used to change sets of disappearing messages in chats SetDisappearingChat
webhook.start() The method is used to start to receive webhooks
webhook.stop() The method is used to stopp to receive webhooks
statuses.sendTextStatus() The method is used to send a text status SendTextStatus
statuses.sendVoiceStatus() The method is used to send a voice status SendVoiceStatus
statuses.sendMediaStatus() The method is used to send a pictures or video status SendMediaStatus
statuses.getIncomingStatuses() The method is used to get the incoming status messages of the instance GetIncomingStatuses
statuses.getOutgoingStatuses() The method is used to get the outgoing statuses of the account GetOutgoingStatuses
statuses.getStatusStatistic() The method is used to get an array of recipients marked sent/delivered/read for a given status GetStatusStatistic