Ir para o conteúdo

Mensagem de entrada de convite para o grupo#

Esta seção descreve o formato de notificação de entrada do objeto messageData para a mensagem de entrada de convite para o grupo. Para obter a descrição do formato geral das notificações de entrada, consulte a seção Mensagens de entrada.

Para receber notificações de entrada deste tipo, é necessário cumprir duas condições:

typeWebhook = incomingMessageReceived

messageData.typeMessage = groupInviteMessage

Notificação#

Formato de notificação#

Campos do objeto messageData

Parâmetro Tipo Descrição
typeMessage string Tipo de mensagem recebida. Para mensagens deste tipo, o campo recebe o valor: groupInviteMessage
groupInviteMessageData object Objeto de dados sobre a mensagem de convite recebida para o grupo
quotedMessage object Objeto de dados sobre a mensagem citada.

Campos do objeto groupInviteMessageData

Parâmetro Tipo Descrição
groupJid string chatId do grupo
inviteCode string Código do convite
inviteExpiration string Prazo de validade do convite
groupName string Nome do grupo
caption string Descrição da mensagem
name string Nome do remetente
jpegThumbnail string Visualização da imagem em base64

Campos do objeto quotedMessage

Parâmetro Tipo Descrição
stanzaId string id da mensagem citada
participant string id do remetente da mensagem citada
typeMessage string Tipo da mensagem citada

Os demais campos são preenchidos de acordo com o tipo da mensagem citada e são idênticos aos campos das mensagens de entrada descritas na seção Mensagens de entrada

Exemplo de corpo de notificação#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "chatName": "Grin",
    "sender": "79001234568@c.us",
    "senderName": "Grin"
  },
  "messageData": {
    "typeMessage": "groupInviteMessage",
    "groupInviteMessageData": {
      "groupJid": "79099197688-1506012221@g.us",
      "inviteCode": "a7E5WU/g7rmjaQnv",
      "inviteExpiration": "0",
      "groupName": "Makhlovka, desenho 4-6",
      "caption": "Convite para meu grupo do WhatsApp",
      "name": "meunome",
      "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQY/9k="
    }
  }
}