Skip to content

The full list of the library methods#

Method Description Documentation
account.getSettings The method is used to get the current settings of the instance GetSettings
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 instance socket connection with WhatsApp GetStatusInstance
account.logout The method is used to log out an instance Logout
account.qr The method is used to get QR code QR
account.reboot The method is used to reboot an instance Reboot
account.setProfilePicture The method is used to set an account picture SetProfilePicture
account.setSettings The method is used to set an instance settings SetSettings
groups.addGroupParticipant The method is used to add a participant to a group chat AddGroupParticipant
groups.createGroup The method is used to create a group chat CreateGroup
groups.getGroupData The method is used to get group chat data GetGroupData
groups.leaveGroup The method is used to make the current account user leave the group chat LeaveGroup
groups.removeAdmin The method is used to remove a participant from group chat administration rights RemoveAdmin
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.setGroupPicture The method is used to set a group picture SetGroupPicture
groups.updateGroupName The method is used to change a group chat name UpdateGroupName
journals.getChatHistory The method is used to get the chat message history GetChatHistory
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
marking.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
device.getDeviceInfo The method is used to get information about the device (phone) running WhatsApp Business application GetDeviceInfo
queues.clearMessagesQueue The method is used to clear the queue of messages to be sent ClearMessagesQueue
queues.showMessagesQueue The method is used to get a list of messages in the queue to be sent ShowMessagesQueue
receiving.deleteNotification The method is used to delete an incoming notification from the notification queue DeleteNotification
receiving.receiveNotification The method is used to receive one incoming notification from the notifications queue ReceiveNotification
sending.sendButtons The method is used to send a button message to a personal or a group chat SendButtons
sending.sendContact The method is used to send a contact message SendContact
sending.sendFileByUpload The method is used to send a file uploaded by form SendFileByUpload
sending.sendFileByUrl The method is used to send a file uploaded by Url SendFileByUrl
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.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.sendLocation The method is used to send a location message SendLocation
sending.sendMessage The method is used to send a text message to a personal or a group chat SendMessage
sending.sendTemplateButtons The method is used to send a message with template list interactive buttons to a personal or a group chat SendTemplateButtons
serviceMethods.checkWhatsapp The method is used to check WhatsApp account availability on a phone number CheckWhatsapp
serviceMethods.getAvatar The method is used to get a user or a group chat avatar GetAvatar
serviceMethods.getContactInfo The method is used to get information on a contact GetContactInfo
serviceMethods.getContacts The method is used to get a list of the current account contacts GetContacts
serviceMethods.setDisappearingChat The method is used to changing sets of disappearing messages in chats. The standard sets of the application are to be used: 0 (off), 86400 (24 hours), 604800 (7 days), 7776000 (90 days) SetDisappearingChat
serviceMethods.archiveChat The method is used to archive a chat. One can archive chats that have at least one incoming message ArchiveChat
serviceMethods.editMessage The method is used to edit a message in a chat EditMessage
serviceMethods.deleteMessage The method is used to delete a message from a chat DeleteMessage
serviceMethods.unarchiveChat The method is used to unarchive a chat UnarchiveChat
serviceMethods.setDisappearingChat The method is used to changing sets of disappearing messages in chats SetDisappearingChat
webhooks.startReceivingNotifications The method is used to star to receive webhooks
webhooks.stopReceivingNotifications The method is used to stop 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