Ir para o conteúdo

Lista completa de métodos da biblioteca#

Método Descrição Documentação
account.getSettings Obtém as configurações atuais da conta GetSettings
account.getStateInstance Obtém o estado da conta GetStateInstance
account.getStatusInstance Obtém o estado do socket de conexão da instância da conta com o WhatsApp GetStatusInstance
account.logout Desconecta a conta Logout
account.qr Obtém o código QR QR
account.reboot Reinicia a conta Reboot
account.setProfilePicture Define a imagem de perfil da conta SetProfilePicture
account.setSettings Define as configurações da conta SetSettings
groups.addGroupParticipant Adiciona um participante a um chat em grupo AddGroupParticipant
groups.createGroup Cria um chat em grupo. IMPORTANTE: Se você tentar criar um grupo com um número WhatsApp inexistente, pode resultar no bloqueio do número do remetente. CreateGroup
groups.getGroupData Obtém os dados de um chat em grupo GetGroupData
groups.leaveGroup Sai do chat em grupo LeaveGroup
groups.removeAdmin Remove os privilégios de administrador de um participante do chat em grupo RemoveAdmin
groups.removeGroupParticipant Remove um participante do chat em grupo RemoveGroupParticipant
groups.setGroupAdmin Define um participante como administrador do chat em grupo SetGroupAdmin
groups.setGroupPicture Define a imagem de perfil do chat em grupo SetGroupPicture
groups.updateGroupName Atualiza o nome do chat em grupo UpdateGroupName
journals.getChatHistory Obtém o histórico de mensagens de um chat GetChatHistory
journals.lastIncomingMessages Obtém as últimas mensagens de entrada do(s) último(s) contato(s). Por padrão, retorna as mensagens dos últimos 24 horas. LastIncomingMessages
journals.lastOutgoingMessages Obtém as últimas mensagens enviadas pelo(s) último(s) contato(s). Por padrão, retorna as mensagens dos últimos 24 horas. LastOutgoingMessages
marking.readChat Marca as mensagens em um chat como lidas. Pode marcar todas as mensagens no chat ou apenas uma mensagem específica ReadChat
device.getDeviceInfo Obtém informações sobre o dispositivo (telefone) em que o aplicativo WhatsApp Business está sendo executado GetDeviceInfo
queues.clearMessagesQueue Limpa a fila de mensagens para envio ClearMessagesQueue
queues.showMessagesQueue Obtém a lista de mensagens na fila de envio ShowMessagesQueue
receiving.deleteNotification Exclui uma notificação de entrada da fila de notificações DeleteNotification
receiving.receiveNotification Obtém uma notificação de entrada da fila de notificações ReceiveNotification
sending.sendButtons Envia uma mensagem com botões para um chat pessoal ou em grupo SendButtons
sending.sendContact Envia uma mensagem com um contato SendContact
sending.sendFileByUpload Envia um arquivo carregado por upload SendFileByUpload
sending.sendFileByUrl Envia um arquivo a partir de uma URL SendFileByUrl
sending.sendLink Envia uma mensagem com um link, que incluirá uma prévia da imagem, título e descrição SendLink
sending.sendListMessage Envia uma mensagem com um botão de seleção de uma lista de valores para um chat pessoal ou em grupo SendListMessage
sending.sendLocation Envia uma mensagem de localização SendLocation
sending.sendMessage Envia uma mensagem de texto para um chat pessoal ou em grupo SendMessage
sending.sendTemplateButtons Envia uma mensagem com botões interativos de uma lista de modelos para um chat pessoal ou em grupo SendTemplateButtons
serviceMethods.checkWhatsapp Verifica a presença de uma conta WhatsApp em um número de telefone CheckWhatsapp
serviceMethods.getAvatar Obtém o avatar de um contato ou chat em grupo GetAvatar
serviceMethods.getContactInfo Obtém informações de um contato GetContactInfo
serviceMethods.getContacts Obtém a lista de contatos da conta atual GetContacts
serviceMethods.setDisappearingChat Define as configurações de mensagens que desaparecem em chats. Use os valores padrão do aplicativo: 0 (desativado), 86400 (24 horas), 604800 (7 dias), 7776000 (90 dias) SetDisappearingChat
serviceMethods.archiveChat Arquiva um chat. Somente chats que contenham pelo menos uma mensagem de entrada podem ser arquivados ArchiveChat
serviceMethods.deleteMessage Exclui uma mensagem de um chat DeleteMessage
serviceMethods.unarchiveChat Desarquiva um chat UnarchiveChat
serviceMethods.setDisappearingChat Define as configurações de mensagens que desaparecem em chats SetDisappearingChat
webhooks.startReceivingNotifications Inicia o recebimento de notificações via webhook
webhooks.stopReceivingNotifications Interrompe o recebimento de notificações via webhook