Skip to content

The full list of the library methods#

Method Description Documentation
account.getSettings The method is aimed for getting the current settings of the account GetSettings
account.getStateInstance The method is aimed for getting the account state GetStateInstance
account.getStatusInstance The method is aimed for getting the status of the account instance socket connection with WhatsApp GetStatusInstance
account.logout The method is aimed for logging out an account Logout
account.qr The method is aimed for getting QR code QR
account.reboot The method is aimed for rebooting an account Reboot
account.setProfilePicture The method is aimed for setting an account picture SetProfilePicture
account.setSettings The method is aimed for setting an account settings SetSettings
groups.addGroupParticipant The method adds a participant to a group chat AddGroupParticipant
groups.createGroup The method adds 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.getGroupData The method gets group chat data GetGroupData
groups.leaveGroup The method makes the current account user leave the group chat LeaveGroup
groups.removeAdmin The method removes a participant from group chat administration rights RemoveAdmin
groups.removeGroupParticipant The method removes a participant from a group chat RemoveGroupParticipant
groups.setGroupAdmin The method sets a group chat participant as an administrator SetGroupAdmin
groups.setGroupPicture The method sets a group picture SetGroupPicture
groups.updateGroupName The method changes a group chat name UpdateGroupName
journals.getChatHistory The method returns the chat message history GetChatHistory
journals.lastIncomingMessages The method returns the last incoming messages of the account. In the default mode the incoming messages for 24 hours are returned lastIncomingMessages
journals.lastOutgoingMessages The method returns the last outgoing messages of the account. In the default mode the last messages for 24 hours are returned LastOutgoingMessages
marking.readChat The method is aimed for marking messages in a chat as read. Either all messages or a specified message in a chat can be marked as read ReadChat
device.getDeviceInfo The method is aimed for getting information about the device (phone) running WhatsApp Business application GetDeviceInfo
queues.clearMessagesQueue The method is aimed for clearing the queue of messages to be sent ClearMessagesQueue
queues.showMessagesQueue The method is aimed for getting a list of messages in the queue to be sent ShowMessagesQueue
receiving.deleteNotification The method is aimed for deleting an incoming notification from the notification queue DeleteNotification
receiving.receiveNotification The method is aimed for receiving one incoming notification from the notifications queue ReceiveNotification
sending.sendButtons The method is aimed for sending a button message to a personal or a group chat SendButtons
sending.sendContact The method is aimed for sending a contact message SendContact
sending.sendFileByUpload The method is aimed for sending a file uploaded by form SendFileByUpload
sending.sendFileByUrl The method is aimed for sending a file uploaded by Url SendFileByUrl
sending.sendLink The method is aimed for sending a message with a link, by which an image preview, title and description will be added (deprecated) SendLink
sending.sendListMessage The method is aimed for sending a message with a select button from a list of values to a personal or a group chat SendListMessage
sending.sendLocation The method is aimed for sending a location message SendLocation
sending.sendMessage The method is aimed for sending a text message to a personal or a group chat SendMessage
sending.sendTemplateButtons The method is aimed for sending a message with template list interactive buttons to a personal or a group chat SendTemplateButtons
serviceMethods.checkWhatsapp The method checks WhatsApp account availability on a phone number CheckWhatsapp
serviceMethods.getAvatar The method returns a user or a group chat avatar GetAvatar
serviceMethods.getContactInfo The method is aimed for getting information on a contact GetContactInfo
serviceMethods.getContacts The method is aimed for getting a list of the current account contacts GetContacts
serviceMethods.setDisappearingChat The method is aimed for changing settings of disappearing messages in chats. The standard settings of the application are to be used: 0 (off), 86400 (24 hours), 604800 (7 days), 7776000 (90 days) SetDisappearingChat
serviceMethods.archiveChat The method archives a chat. One can archive chats that have at least one incoming message ArchiveChat
serviceMethods.deleteMessage The method deletes a message from a chat DeleteMessage
serviceMethods.unarchiveChat The method unarchives a chat UnarchiveChat
serviceMethods.setDisappearingChat The method is aimed for changing settings of disappearing messages in chats SetDisappearingChat
webhooks.startReceivingNotifications The method is aimed for starting to receive webhooks
webhooks.stopReceivingNotifications The method is aimed for stopping to receive webhooks