Skip to content

Full list of all methods#

API Method Description Documentation link
Account().GetSettings The method is aimed for getting the current settings of the instance GetSettings
Account().SetSettings The method is aimed for setting an inatsnce settings SetSettings
Account().GetStateInstance The method is aimed for getting the instance state GetStateInstance
Account().GetStatusInstance The method is aimed for getting the status of the account instance socket connection with WhatsApp GetStatusInstance
Account().Reboot The method is aimed for rebooting an instance Reboot
Account().Logout The method is aimed for logging out an instance Logout
Account().QR The method is aimed for getting QR code QR
Account().SetProfilePicture The method is aimed for setting an account picture SetProfilePicture
Device().GetDeviceInfo The method is aimed for getting information about the device (phone) running WhatsApp Business application GetDeviceInfo
Groups().CreateGroup The method is aimed for creating a group chat CreateGroup
Groups().UpdateGroupName The method is aimed for changing a group chat name UpdateGroupName
Groups().GetGroupData The method is aimed for getting a group chat data GetGroupData
Groups().AddGroupParticipant The method is aimed for adding a participant into a group AddGroupParticipant
Groups().RemoveGroupParticipant The method is aimed for deleting a participant from a group chat RemoveGroupParticipant
Groups().SetGroupAdmin The method is aimed for setting a participant as a group administrator SetGroupAdmin
Groups().RemoveAdmin The method is aimed for removing administrator rights from a participant RemoveAdmin
Groups().SetGroupPicture The method is aimed for setting a group picture SetGroupPicture
Groups().LeaveGroup The method is aimed for leaving from a group LeaveGroup
Journals().GetChatHistory The method is aimed for getting a chat history GetChatHistory
Journals().GetMessage The method is aimed for getting a message GetMessage
Journals().LastIncomingMessages The method is aimed for getting last incoming messages LastIncomingMessages
Journals().LastOutgoingMessages The method is aimed for getting last outgoing messages LastOutgoingMessages
Queues().ShowMessagesQueue The method is aimed for getting messages that are in the outgoing messages queue ShowMessagesQueue
Queues().ClearMessagesQueue The method is aimed for clearing messages from the outgoing message queue ClearMessagesQueue
ReadMark().ReadChat The method is aimed for marking a chat as read ReadChat
Receiving().ReceiveNotification The method is aimed for receiving a notification from the incoming notification queue ReceiveNotification
Receiving().DeleteNotification The method is aimed for deleting a notification from the incoming notification queue DeleteNotification
Receiving().DownloadFile The method is aimed for downloading file from outgoing or incoming message DownloadFile
Sending().SendMessage The method is aimed for sending a text message to a personal or group chat SendMessage
Sending().SendButtons The method is aimed for sending buttons to a personal or group chat SendButtons
Sending().SendTemplateButtons The method is aimed for sending a message with interactive buttons from the list of templates in a personal or group chat SendTemplateButtons
Sending().SendListMessage The method is aimed for sending a message with a selection button from a list of values to a personal or group chat SendListMessage
Sending().SendFileByUpload The method is aimed for sending a file through a form (form-data) SendFileByUpload
Sending().SendFileByUrl The method is aimed for sending a file by URL SendFileByUrl
Sending().SendLocation The method is aimed for sending a location SendLocation
Sending().SendContact The method is aimed for sending a contact SendContact
Sending().SendLink The method is aimed for a message with a link that will add an image preview, title and description (Not used) SendLink
Sending().ForwardMessages The method is aimed for forwarding messages to a personal or group chat ForwardMessages
Service().CheckWhatsapp The method is aimed for checking if there is a WhatsApp account on the phone number CheckWhatsapp
Service().GetAvatar The method is aimed for getting the avatar of the correspondent or group chat GetAvatar
Service().GetContacts The method is aimed for getting contacts of current account GetContacts
Service().GetContactInfo The method is aimed for getting information of the contact GetContactInfo
Service().DeleteMessage The method is aimed for deleting a messages from the chat DeleteMessage
Service().ArchiveChat The method is aimed for archiving a chat ArchiveChat
Service().UnarchiveChat The method is aimed for unarchiving a chat UnarchiveChat
Service().SetDisappearingChat The method is aimed for changing the settings of disappearing messages in chats SetDisappearingChat