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 account GetSettings
Account().GetWaSettings The method is used to get information about the WhatsApp account GetSettings
Account().SetSettings The method is used to set the account settings SetSettings
Account().GetStateInstance The method is used to get the state of the account GetStateInstance
Account().Reboot The method is used to restart the account Reboot
Account().Logout The method is used to log out from the account 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
Account().GetAuthorizationCode The method is used to authorize an instance by phone number GetAuthorizationCode
Groups().CreateGroup The method is used to create a group chat CreateGroup
Groups().UpdateGroupName The method changes the name of the group chat UpdateGroupName
Groups().GetGroupData The method gets group chat data GetGroupData
Groups().AddGroupParticipant The method adds a participant to the group chat AddGroupParticipant
Groups().RemoveGroupParticipant The method removes the participant from the group chat RemoveGroupParticipant
Groups().SetGroupAdmin The method designates a member of a group chat as an administrator SetGroupAdmin
Groups().RemoveAdmin The method deprives the participant of group chat administration rights RemoveAdmin
Groups().SetGroupPicture The method sets the avatar of the group SetGroupPicture
Groups().LeaveGroup The method logs the user of the current account out of the group chat LeaveGroup
Journals().GetChatHistory The method returns the chat message history GetChatHistory
Journals().GetMessage The method returns a chat message GetMessage
Journals().LastIncomingMessages The method returns the most recent incoming messages of the account LastIncomingMessages
Journals().LastOutgoingMessages The method returns 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 for downloading received and sent files DownloadFile
Sending().SendMessage The method is used to send a text message to a personal or group chat SendMessage
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().UploadFile The method allows you to upload a file from the local file system, which can later be sent using the SendFileByUrl method UploadFile
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().ForwardMessages The method is designed for forwarding messages to a personal or group chat ForwardMessages
Sending().SendPoll The method is designed for sending messages with a poll to a private or group chat SendPoll
Service().CheckWhatsapp The method checks if there is a WhatsApp account on the phone number CheckWhatsapp
Service().GetAvatar The method returns the avatar of the correspondent 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().EditMessage The method edits the message in a chat EditMessage
Service().DeleteMessage The method deletes the message from chat DeleteMessage
Service().ArchiveChat The method archives the chat ArchiveChat
Service().UnarchiveChat The method unarchives the chat UnarchiveChat
Service().SetDisappearingChat The method is used to change the settings of disappearing messages in chats SetDisappearingChat
Partner().GetInstances The method is for getting all the account instances created by the partner. GetInstances
Partner().CreateInstance The method is for creating an instance. CreateInstance
Partner().DeleteInstanceAccount The method is for deleting an instance. DeleteInstanceAccount
Statuses().SendTextStatus The method is used to sending a text status SendTextStatus
Statuses().SendVoiceStatus The method is used to sending a voice status SendVoiceStatus
Statuses().SendMediaStatus The method is used to sending a voice status SendMediaStatus
Statuses().GetOutgoingStatuses The method returns the outgoing statuses of the account GetOutgoingStatuses
Statuses().GetIncomingStatuses The method returns the incoming status messages of the account GetIncomingStatuses
Statuses().GetStatusStatistic The method returns an array of recipients marked for a given status. GetStatusStatistic
Statuses().DeleteStatus The method is used to deleting status. DeleteStatus