Skip to content

The full list of the library methods#

API method Description Documentation link
Account().GetSettings The method is used to get the current settings of the instance GetSettings
Account().SetSettings The method is used to set the instance settings SetSettings
Account().GetStateInstance The method is used to get the state of the instance GetStateInstance
Account().GetStatusInstance The method is used to get the socket connection state of the account instance with WhatsApp GetStatusInstance
Account().Reboot The method is used to restart the instance Reboot
Account().Logout The method is used to log out from the instance Logout
Account().QR The method is used to get a QR code QR
Account().SetProfilePicture The method is used to set the avatar of the account SetProfilePicture
Device().GetDeviceInfo The method is used to get information about the device (phone) on which the WhatsApp Business application is running GetDeviceInfo
Groups().CreateGroup The method is used to create a group chat CreateGroup
Groups().UpdateGroupName The method is used to change the name of the group chat UpdateGroupName
Groups().GetGroupData The method is used to get group chat data GetGroupData
Groups().AddGroupParticipant The method is used to add a participant to the group chat AddGroupParticipant
Groups().RemoveGroupParticipant The method is used to remove the participant from the group chat RemoveGroupParticipant
Groups().SetGroupAdmin The method is used to set a group participant as an administrator SetGroupAdmin
Groups().RemoveAdmin The method is used to remove a group participant administration rights RemoveAdmin
Groups().SetGroupPicture The method is used to set the avatar of the group SetGroupPicture
Groups().LeaveGroup The method is used to log the user of the current account out of 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 a chat message GetMessage
Journals().LastIncomingMessages The method is used to get the most recent incoming messages of the account LastIncomingMessages
Journals().LastOutgoingMessages The method is used to get the last sent messages of the account LastOutgoingMessages
Queues().ShowMessagesQueue The method is used to get the list of messages that are in the queue to be sent ShowMessagesQueue
Queues().ClearMessagesQueue The method is used to clear the queue of messages to be sent ClearMessagesQueue
ReadMark().ReadChat The method is used to mark chat messages as read ReadChat
Receiving().ReceiveNotification The method is used to receive a single incoming notification from the notification queue ReceiveNotification
Receiving().DeleteNotification The method is used to remove an incoming notification from the notification queue DeleteNotification
Receiving().DownloadFile The method is used to download files from messages DownloadFile
Sending().SendMessage The method is used to send a text message to a personal or group chat SendMessage
Sending().SendButtons The method is used to send a message with buttons to a personal or group chat SendButtons
Sending().SendTemplateButtons The method is used to send a message with interactive buttons from the list of templates in a personal or group chat SendTemplateButtons
Sending().SendListMessage The method is used to send a message with a selection button from a list of values to a personal or group chat SendListMessage
Sending().SendFileByUpload The method is used to send a file loaded through a form (form-data) SendFileByUpload
Sending().SendFileByUrl The method is used to send a file downloaded via a link SendFileByUrl
Sending().SendLocation The method is used to send a geolocation message SendLocation
Sending().SendContact The method is for sending a message with a contact SendContact
Sending().SendLink The method is used to send a message with a link that will add an image preview, title and description (deprecated) SendLink
Sending().ForwardMessages The method is used to forward messages to a personal or group chat ForwardMessages
Service().CheckWhatsapp The method is used to check if there is a WhatsApp account on the phone number CheckWhatsapp
Service().GetAvatar The method is used to get the avatar of the personal or group chat GetAvatar
Service().GetContacts The method is used to get a list of contacts of the current account GetContacts
Service().GetContactInfo The method is used to obtain information about the contact GetContactInfo
Service().DeleteMessage The method is used to delete a message from chat DeleteMessage
Service().ArchiveChat The method is used to archive the chat ArchiveChat
Service().UnarchiveChat The method is used to unarchive the chat UnarchiveChat
Service().SetDisappearingChat The method is used to change the settings of disappearing messages in chats SetDisappearingChat
Webhook().Start The method is used to start receiving new notifications
Webhook().Stop The method is used to stop receiving new notifications