Lista de eventos suportados e exemplos
Estamos em processo de melhorias da nossa documentação, em breve estaremos incluindo mais eventos com seus devidos exemplos.
instance.connected
A instância foi conectada com sucesso e está pronta para envio e recebimento de mensagens.
Exemplo
instance.disconnected
A instância foi desconectada com sucesso.
Algumas vezes a desconexão pode acontecer devido a falhas internas do Whatsapp, internamente temos estrategias de recuperação, nestes casos o evento instance.connected
pode ser emitido alguns segundos depois do evento de desconexão.
Exemplo
message.received
Uma mensagem foi recebida na instância. Para detalhamento completo de como é o formato do objeto mensagem verifique na página Estrutura dos eventos > Mensagem
Exemplo: Mensagem de texto
Exemplo: Mensagem com imagem
Exemplo: Mensagem com áudio
Exemplo: Mensagem de localização
Exemplo: Mensagem com Sticker
Exemplo: Mensagem com GIF ou Vídeo
Exemplo: Mensagem "quoted" (ou resposta) para outra mensagem
Observe a propriedade data.content.quoted
, ela representa a citação ou marcação de quem está respondendo e tem o mesmo formato de uma message.received
.
Exemplo: Mensagem resposta à um status
Observe que o status respondido ficará dentro de data.content.quoted
que terá o mesmo formato de uma message.received
, a grande diferença aqui é que você verá uma nova propriedade data.content.quoted.origin
sendo o seu valor igual à status
.
Em alguns casos você pode encontrar uma variação do payload contendo uma propriedade para status que são postado em formato de texto, seu valor representará a cor do fundo (background), contendo no formato decimal, hexadecimal com e sem o canal alfa (transparência).
Exemplo: Mensagem com vcard (contatos)
Se a propriedade waid
(ela pode ser ausente) estiver presente dentro de data.content.contacts.phones
isso pode siginificar que o telefone / contato recebido tem um whatsapp válido.
Exemplo: Mensagem com botões
As mensagens com botões poderão chegar com os tipos text, image ou video e sempre acompanhada da propriedade buttons em seu conteudo (data.content
).
Exemplo: Mensagem resposta à botões
Assim como o exemplo acima, o tipo de mensagem chegará como text, video ou image porém a propriedade button_reply (data.button_reply
) mostrará qual botão o usuário pressionou.
Exemplo: Mensagem com lista de opções
Exemplo: Mensagem resposta à lista de opções
Assim como o exemplo acima, o tipo de mensagem chegará como text porém a propriedade list_reply (data.list_reply
) mostrará qual opção o usuário selecionou.
message.sent
Uma mensagem foi enviada da instância mensagem pode ter sido enviada através do Whatsapp ou através da API da Zapster.
Você consegue identificar facilmente a origem do envio olhando para a propriedade data.origin
que tem 2 valores possíveis (zapsterapi
ou whatsapp
), que identificarão a origem do envio da mensagem.
Para detalhamento completo de como é o formato do objeto mensagem verifique na página Estrutura dos eventos > Mensagem
Exemplo: Mensagem de texto
Lista de eventos suportados e exemplos
Estamos em processo de melhorias da nossa documentação, em breve estaremos incluindo mais eventos com seus devidos exemplos.
instance.connected
A instância foi conectada com sucesso e está pronta para envio e recebimento de mensagens.
Exemplo
instance.disconnected
A instância foi desconectada com sucesso.
Algumas vezes a desconexão pode acontecer devido a falhas internas do Whatsapp, internamente temos estrategias de recuperação, nestes casos o evento instance.connected
pode ser emitido alguns segundos depois do evento de desconexão.
Exemplo
message.received
Uma mensagem foi recebida na instância. Para detalhamento completo de como é o formato do objeto mensagem verifique na página Estrutura dos eventos > Mensagem
Exemplo: Mensagem de texto
Exemplo: Mensagem com imagem
Exemplo: Mensagem com áudio
Exemplo: Mensagem de localização
Exemplo: Mensagem com Sticker
Exemplo: Mensagem com GIF ou Vídeo
Exemplo: Mensagem "quoted" (ou resposta) para outra mensagem
Observe a propriedade data.content.quoted
, ela representa a citação ou marcação de quem está respondendo e tem o mesmo formato de uma message.received
.
Exemplo: Mensagem resposta à um status
Observe que o status respondido ficará dentro de data.content.quoted
que terá o mesmo formato de uma message.received
, a grande diferença aqui é que você verá uma nova propriedade data.content.quoted.origin
sendo o seu valor igual à status
.
Em alguns casos você pode encontrar uma variação do payload contendo uma propriedade para status que são postado em formato de texto, seu valor representará a cor do fundo (background), contendo no formato decimal, hexadecimal com e sem o canal alfa (transparência).
Exemplo: Mensagem com vcard (contatos)
Se a propriedade waid
(ela pode ser ausente) estiver presente dentro de data.content.contacts.phones
isso pode siginificar que o telefone / contato recebido tem um whatsapp válido.
Exemplo: Mensagem com botões
As mensagens com botões poderão chegar com os tipos text, image ou video e sempre acompanhada da propriedade buttons em seu conteudo (data.content
).
Exemplo: Mensagem resposta à botões
Assim como o exemplo acima, o tipo de mensagem chegará como text, video ou image porém a propriedade button_reply (data.button_reply
) mostrará qual botão o usuário pressionou.
Exemplo: Mensagem com lista de opções
Exemplo: Mensagem resposta à lista de opções
Assim como o exemplo acima, o tipo de mensagem chegará como text porém a propriedade list_reply (data.list_reply
) mostrará qual opção o usuário selecionou.
message.sent
Uma mensagem foi enviada da instância mensagem pode ter sido enviada através do Whatsapp ou através da API da Zapster.
Você consegue identificar facilmente a origem do envio olhando para a propriedade data.origin
que tem 2 valores possíveis (zapsterapi
ou whatsapp
), que identificarão a origem do envio da mensagem.
Para detalhamento completo de como é o formato do objeto mensagem verifique na página Estrutura dos eventos > Mensagem
Exemplo: Mensagem de texto