Перейти к содержанию

Полный список методов библиотеки#

Метод Описание Документация
account.getSettings Метод предназначен для получения текущих настроек аккаунта GetSettings
account.getStateInstance Метод предназначен для получения состояния аккаунта GetStateInstance
account.getStatusInstance Метод предназначен для получения состояния сокета соединения инстанса аккаунта с WhatsApp GetStatusInstance
account.logout Метод предназначен для разлогинивания аккаунта Logout
account.qr Метод предназначен для получения QR-кода QR
account.reboot Метод предназначен для перезапуска аккаунта Reboot
account.setProfilePicture Метод предназначен для установки аватара аккаунта SetProfilePicture
account.setSettings Метод предназначен для установки настроек аккаунта SetSettings
account.setSystemProxy Метод предназначен для установки системного прокси. Нужно используйте метод, когда требуется сбросить пользовательские настройки прокси на системные SetSystemProxy
groups.addGroupParticipant Метод добавляет участника в групповой чат AddGroupParticipant
groups.createGroup Метод добавляет участника в групповой чат. ВАЖНО: Если попытаться создать группу с несуществующим номером WhatsApp может заблокировать номер отправителя. CreateGroup
groups.getGroupData Метод получает данные группового чата GetGroupData
groups.leaveGroup Метод производит выход пользователя текущего аккаунта из группового чата LeaveGroup
groups.removeAdmin Метод лишает участника прав администрирования группового чата RemoveAdmin
groups.removeGroupParticipant Метод удаляет участника из группового чата RemoveGroupParticipant
groups.setGroupAdmin Метод назначает участника группового чата администратором SetGroupAdmin
groups.setGroupPicture Метод устанавливает аватар группы SetGroupPicture
groups.updateGroupName Метод изменяет наименование группового чата UpdateGroupName
journals.getChatHistory Метод возвращает историю сообщений чата GetChatHistory
journals.lastIncomingMessages Метод возвращает крайние входящие сообщения аккаунта. По умолчанию возвращаются последние сообщения за 24 часа lastIncomingMessages
journals.lastOutgoingMessages Метод возвращает крайние отправленные сообщения аккаунта. По умолчанию возвращаются последние сообщения за 24 часа LastOutgoingMessages
marking.readChat Метод предназначен для отметки сообщений в чате прочитанными. Могут быть отмечены прочитанными все сообщения в чате или только одно заданное сообщение ReadChat
device.getDeviceInfo Метод предназначен для получения информации об устройстве (телефоне), на котором запущено приложение WhatsApp Business GetDeviceInfo
queues.clearMessagesQueue Метод предназначен для очистки очереди сообщений на отправку ClearMessagesQueue
queues.showMessagesQueue Метод предназначен для получения списка сообщений, находящихся в очереди на отправку ShowMessagesQueue
receiving.deleteNotification Метод предназначен для удаления входящего уведомления из очереди уведомлений DeleteNotification
receiving.receiveNotification Метод предназначен для получения одного входящего уведомления из очереди уведомлений ReceiveNotification
sending.sendButtons Метод предназначен для отправки сообщения с кнопками в личный или групповой чат SendButtons
sending.sendContact Метод предназначен для отправки сообщения с контактом SendContact
sending.sendFileByUpload Метод предназначен для отправки файла, загружаемого через форму SendFileByUpload
sending.sendFileByUrl Метод предназначен для отправки файла, загружаемого по ссылке SendFileByUrl
sending.sendLink Метод предназначен для отправки сообщения со ссылкой, по которой будут добавлены превью изображения, заголовок и описание SendLink
sending.sendListMessage Метод предназначен для отправки сообщения с кнопкой выбора из списка значений в личный или групповой чат SendListMessage
sending.sendLocation Метод предназначен для отправки сообщения геолокации SendLocation
sending.sendMessage Метод предназначен для отправки текстового сообщения в личный или групповой чат SendMessage
sending.sendTemplateButtons Метод предназначен для отправки сообщения с интерактивными кнопками из перечня шаблонов в личный или групповой чат SendTemplateButtons
serviceMethods.checkWhatsapp Метод проверяет наличие аккаунта WhatsApp на номере телефона CheckWhatsapp
serviceMethods.getAvatar Метод возвращает аватар корреспондента или группового чата GetAvatar
serviceMethods.getContactInfo Метод предназначен для получения информации о контакте GetContactInfo
serviceMethods.getContacts Метод предназначен для получения списка контактов текущего аккаунта GetContacts
serviceMethods.setDisappearingChat Метод предназначен для изменения настроек исчезающих сообщений в чатах. Нужно использовать стандартные настройки приложения: 0 (выключено), 86400 (24 часа), 604800 (7 дней), 7776000 (90 дней) SetDisappearingChat
serviceMethods.archiveChat Метод архивирует чат. Архивировать можно чаты, в которых есть хотя бы одно входящее сообщение ArchiveChat
serviceMethods.deleteMessage Метод удаляет сообщение из чата DeleteMessage
serviceMethods.unarchiveChat Метод разархивирует чат UnarchiveChat
serviceMethods.setDisappearingChat Метод предназначен для изменения настроек исчезающих сообщений в чатах SetDisappearingChat
webhooks.startReceivingNotifications Метод предназначен для запуска получения вебхуков <библиотечный метод>
webhooks.stopReceivingNotifications Метод предназначен для остановки получения вебхуков <библиотечный метод>