Pular para o conteúdo principal

Ao receber

Conceituação#

Esse é o webhook de retorno de mensagens recebidas, também é executada quando a sua instância está configurada para notificar também mensagens enviadas por você mesmo.

Qual o prazo de validade dos arquivos do z-api?

Todos os arquivos de midia recebidos do z-api através do seu webhook tem o prazo de expiração de 30 dias. Após esse período todos os arquivos, seja audio, pdf, imagem, etc, serão excluídos do storage.

Atenção

O Z-API não aceita webhooks que não sejam HTTPS


Atualizando Webhook#

Para atualizar a rota do webhook é possível fazer isso pela API ou pelo painel administrativo.

API#

/update-webhook-received#

PUT https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-received

Ou#

Também é possível atualizar a rota com a opção "enviadas por mim" habilitada.

/update-webhook-received-delivery#

PUT https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-received-delivery

img

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Request Body#

{
"value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/receive"
}

Painel Administrativo#

img


Retornos dos webhooks#

Os possíveis retornos do webhook on-message-received estão cadastrado logo abaixo:

Response#

AtributosTipoDescrição
isStatusReplybooleanIdentifica se a mensagem recebida é uma resposta de status
senderLidstringID do contato no whatsapp
connectedPhonestringNúmero de telefone conectado à API
waitingMessagebooleanIdentifica se a sua mensagem está com status de "Aguardando a mensagem"
isEditbooleanIdentifica se a mensagem recebida foi editada
isGroupbooleanIndica se o chat é um grupo
isNewsletterbooleanIndica se o chat é um canal
phonestringNúmero de telefone, ou do grupo que enviou a mensagem.
fromMebooleanIndica se a mensagem enviada partiu do número conectado a API
participantPhonestringNúmero de telefone do membro do grupo que enviou a mensagem.
participantLidstringID do contado no whatsapp, do participante que enviou a mensagem dentro de um grupo
messageIdstringIdetificador da mensagem na conversa.
statusstringStatus que a mensagem se encontra no momento do envio (PENDING, SENT, RECEIVED, READ ou PLAYED).
referenceMessageIdstringReferência a mensagem que foi respondida para o caso da mensagem recebida ser uma resposta a uma mensagem da conversa.
mommentintegerMomento em que a mensagem foi recebida ou do erro.
messageExpirationSecondsintegerTempo das mensagens temporárias
typestringTipo do evento da instância, nesse caso será "ReceivedCallBack".
photostringUrl da foto do usuário que enviou a mensagem.
text.messagestringTexto da mensagem.
image.captionstringLeganda da foto.
image.imageUrlstringUrl da foto.
image.thumbnailUrlstringUrl da thumbnail da foto.
image.mimeTypestringMimeType da imagem.
audio.mimeTypestringMimeType do áudio.
audio.audioUrlstringUrl do áudio.
video.captionstringLegenda do vídeo.
video.videoUrlstringUrl do vídeo.
video.mimeTypestringMimeType do vídeo.
contact.displayNamestringNome do contato.
contact.vCardstringVCard contendo as informações do contato.
document.mimeTypestringMimeType do documento.
document.fileNamestringNome do documento.
document.titlestringTítulo do documento.
document.pageCountstringNúmero de páginas do documento.
document.thumbnailUrlstringUrl da thumbnail do documento.
document.documentUrlstringUrl do documento.
location.thumbnailUrlstringUrl da thumbnail da localização.
location.longitudefloatLongitude da localização.
location.latitudefloatLatitude da localização.
location.urlstringUrl da localização.
location.namestringNome da localização.
location.addressstringEndereço da localização.
sticker.mimeTypestringMimeType do sticker.
sticker.stickerUrlstringUrl do sticker.

200#

Exemplo de retorno de texto#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"text": {
"message": "teste",
"descritpion": "(opcional) em caso da mensagem possuir uma descrição inserida pelo WhatsApp",
"title": "(opcional) em caso da mensagem possuir um título inserido pelo WhatsApp",
"url": "(opcional) caso a mensagem possua um link ligado a ela. Exemplo: mensagem de catálogo possui um botão 'Ver catálogo'",
"thumbnailUrl": "(opcional) caso a mensagem possua uma imagem de thumbnail ligada a ela. Exemplo: mensagem de convite de grupo possui a imagem do grupo"
},
}

Exemplo de retorno de template de texto#

{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "702CC5F7E0A6BF4421",
"phone": "5544999999999",
"fromMe": false,
"momment": 1708457193876,
"status": "RECEIVED",
"chatName": "Test Number",
"senderPhoto": null,
"senderName": "5544999999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {},
"message": "texto da mensagem",
"footer": "rodapé da mensagem",
"title": "título da mensagem",
"templateId": "790118069824606",
"hydratedButtons": []
}
}

Exemplo de retorno de reação#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228955000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"reaction": {
"value": "❤️",
"time": 1651878681150,
"reactionBy": "554499999999",
"referencedMessage": {
"messageId": "3EB0796DC6B777C0C7CD",
"fromMe": true,
"phone": "5544999999999",
"participant": null
}
},
}

Exemplo de retorno de texto (Lista de Botão)#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1634645380000,
"status": "RECEIVED",
"chatName": "Nome",
"senderPhoto": "https://",
"senderName": "Nome",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"referenceMessageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"forwarded": false,
"type": "ReceivedCallback",
"buttonsResponseMessage": {
"buttonId": "1",
"message": "Ótimo"
},
}

Exemplo de retorno de texto (Lista de Opcão)#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1634645683000,
"status": "RECEIVED",
"chatName": "Nome",
"senderPhoto": "https://",
"senderName": "Nome",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"referenceMessageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"forwarded": false,
"type": "ReceivedCallback",
"listResponseMessage": {
"message": "Z-API Asas para sua imaginação",
"title": "Z-API",
"selectedRowId": "1"
},
}

Exemplo de retorno de texto vindos de anúncio#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isGroup": false,
"isEdit": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": NumberLong(1657209752000),
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": null,
"broadcast": false,
"externalAdReply": {
"title": "Titulo",
"body": "texto do anuncio",
"mediaType": NumberInt(1),
"thumbnailUrl": "https://",
"sourceType": "ad",
"sourceId": "23722824350495506",
"sourceUrl": "https://",
"containsAutoReply": false,
"renderLargerThumbnail": true,
"showAdAttribution": true
},
"messageExpirationSeconds": NumberInt(0),
"forwarded": false,
"type": "ReceivedCallback",
"text": {
"message": "mensagem recebida",
"description": "texto do anuncio",
"title": "titulo",
"url": "https://",
"thumbnailUrl": "https://"
}
}

Exemplo de retorno de imagem#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228828000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"image": {
"mimeType": "image/jpeg",
"imageUrl": "https://",
"thumbnailUrl": "https://",
"caption": "",
"thumbnailUrl": "https://",
"width": 600,
"height": 315,
"viewOnce": true
},
}

Exemplo de retorno de template de imagem#

{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "885FF934BF100D579E",
"phone": "554499999999",
"fromMe": false,
"momment": 1708454725028,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"image": {
"imageUrl": "https://example.jpeg",
"thumbnailUrl": "https://example.jpeg",
"caption": "",
"mimeType": "image/jpeg",
"viewOnce": false,
"width": 1600,
"height": 926
}
},
"message": "texto da mensagem",
"footer": "rodapé da mensagem",
"title": "título da mensagem",
"templateId": "674504507982622",
"hydratedButtons": []
}
}

Exemplo de retorno de áudio#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228849000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"audio": {
"ptt": true,
"seconds": 10,
"audioUrl": "https://",
"mimeType": "audio/ogg; codecs=opus",
"viewOnce": true
},
}

Exemplo de retorno de vídeo#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228889000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"video": {
"videoUrl": "https://",
"caption": "",
"mimeType": "video/mp4",
"seconds": 13,
"viewOnce": true
},
}

Exemplo de retorno de template de vídeo#

{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "0E4AD761B62E3D5EF9",
"phone": "5544999999999",
"fromMe": false,
"momment": 1708456287181,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "5544999999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"video": {
"videoUrl": "https://example.mp4",
"caption": "",
"mimeType": "video/mp4",
"width": 0,
"height": 0,
"seconds": 0,
"viewOnce": false
}
},
"message": "texto da mensagem",
"footer": "rodapé da mensagem",
"title": "título da mensagem",
"templateId": "938481574354947",
"hydratedButtons": []
}
}

Exemplo de retorno de PTV#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": true,
"momment": 1688496074000,
"status": "RECEIVED",
"chatName": "eu",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantPhone": "5544999999999",
"messageExpirationSeconds": 0,
"forwarded": true,
"type": "ReceivedCallback",
"video": {
"videoUrl": "https://",
"caption": "",
"mimeType": "video/mp4"
}
}

Exemplo de retorno de contato#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"contact": {
"displayName": "Cesar Baleco",
"vCard": "BEGIN:VCARD\nVERSION:3.0\nN:;nome;;;\nFN:nome\nTEL;type=CELL;type=VOICE;waid=5544999999999:+55 44 9999-9999\nEND:VCARD",
"phones": ["5544999999999"]
},
}

Exemplo de retorno de documento#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228955000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"document": {
"documentUrl": "https://",
"mimeType": "application/pdf",
"title": "nome",
"pageCount": 1,
"fileName": "nome.pdf"
},
}

Exemplo de retorno de template de documento#

{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "9D968A5FA2880508C4",
"phone": "554499999999",
"fromMe": false,
"momment": 1708455444850,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"document": {
"caption": null,
"documentUrl": "https://example.pdf",
"mimeType": "application/pdf",
"title": "",
"pageCount": 0,
"fileName": ""
}
},
"message": "texto da mensagem",
"footer": "rodapé da mensagem",
"title": "título da mensagem",
"templateId": "811492407484976",
"hydratedButtons": []
}
}

Exemplo de retorno de localização#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228970000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"location": {
"longitude": -99.999999999999999,
"latitude": -99.9999999999999999,
"address": "",
"url": ""
},
}

Exemplo de retorno de template de localização#

{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "27BBF23E0185D363D9",
"phone": "554499999999",
"fromMe": false,
"momment": 1708456969808,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"location": {
"longitude": -46.6388,
"latitude": -23.5489,
"name": "nome do lugar",
"address": "nome do enderço",
"url": ""
}
},
"message": "texto da mensagem",
"footer": "rodapé da mensagem",
"title": "título da mensagem",
"templateId": "1143940003434066",
"hydratedButtons": []
}
}

Exemplo de retorno de sticker#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228982000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"sticker": {
"stickerUrl": "https://",
"mimeType": "image/webp"
},
}

Exemplo de retorno de GIF#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228889000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"video": {
"videoUrl": "https://",
"caption": "",
"mimeType": "video/mp4"
},
}

Exemplo de retorno de pagamento feito#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632229683000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"requestPayment": {
"value": 1,
"currencyCode": "BRL",
"expiration": 1632834482000,
"requestPhone": "5544999999999",
"paymentInfo": {
"receiverPhone": "5544999999999",
"value": 1,
"currencyCode": "BRL",
"status": "WAITING",
"transactionStatus": "COLLECT_SUCCESS"
}
},
}

Exemplo de retorno de pedido de pagamento#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": true,
"momment": 1632230332000,
"status": "MESSAGE_RECEIVED",
"chatName": "name",
"senderName": "name",
"participantPhone": "5544999999999",
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"notification": "PAYMENT_ACTION_REQUEST_DECLINED",
"notificationParameters": ["5544999999999", "BRL", "1000"]
}

Exemplo de retorno de recebimento de pagamento#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632230512000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"sendPayment": {
"paymentInfo": {
"receiverPhone": "5544999999999",
"value": 1,
"currencyCode": "BRL",
"status": "COMPLETE",
"transactionStatus": "SUCCESS"
}
},
}

Exemplo de retorno de ligação recebida#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isGroup": false,
"isNewsletter": false,
"isEdit": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "1679655074-84",
"phone": "5544999999999",
"fromMe": false,
"momment": 1679661190000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_VOICE",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436"
}

Exemplo de retorno de ligação perdida#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "1679655074-103",
"phone": "5544999999999",
"fromMe": false,
"momment": 1679661194000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "",
"photo": "https://",
"broadcast": false,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_MISSED_VOICE",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436"
}

Exemplo de solicitação de entrada em grupo#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "464201093",
"phone": "5544999999999-group",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": null,
"broadcast": false,
"participantPhone": "5544999999999",
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "MEMBERSHIP_APPROVAL_REQUEST",
"notificationParameters": [
"5544999999999"
],
"callId": null
}

Exemplo de admin promovido a um canal#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "464201093",
"phone": "5544999999999@newsletter",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"chatName": "nome do canal",
"senderPhoto": null,
"senderName": "",
"photo": null,
"broadcast": false,
"participantPhone": "5544999999999",
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "NEWSLETTER_ADMIN_PROMOTE",
"notificationParameters": [
"5544999999999",
"ADMIN"
],
"callId": null
}

Exemplo de admin removido de um canal#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "464201093",
"phone": "5544999999999@newsletter",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"chatName": "nome do canal",
"senderPhoto": null,
"senderName": "",
"photo": null,
"broadcast": false,
"participantPhone": "5544999999999",
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "NEWSLETTER_ADMIN_DEMOTE",
"notificationParameters": [
"5544999999999",
"SUBSCRIBER"
],
"callId": null
}

Exemplo de retorno de produto#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632233527000,
"status": "RECEIVED",
"senderPhoto": "https://",
"senderName": "5544999999999",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"product": {
"productImage": "https://",
"businessOwnerJid": "5544999999999",
"currencyCode": "BRL",
"productId": "99999999999999999999",
"description": "",
"productImageCount": 1,
"price": 1,
"url": "",
"retailerId": "",
"firstImageId": "",
"title": "name"
},
}

Exemplo de retorno de carrinho#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632233527000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"forwarded": false,
"type": "ReceivedCallback",
"order": {
"itemCount": 1,
"orderId": "422508169684569",
"message": "",
"orderTitle": "name",
"sellerJid": "5544999999999",
"thumbnailUrl": "https://",
"token": "AR5d4yUr+DmSzeCR2kUtPEeMfS+eG0O+S/T/17B+oY1mfA==",
"currency": "BRL",
"total": 2000,
"subTotal": 2000,
"products": [
{
"quantity": 1,
"name": "nameProduct",
"productId": "5338924696127051",
"retailerId": "1242",
"price": 2000,
"currencyCode": "BRL"
}
]
}
}

Exemplo de retorno de enquete#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"poll": {
"question": "Qual a melhor API de Whatsapp?",
"options": [
{
"name": "Z-API"
},
{
"name": "Outras"
}
]
},
}

Exemplo de retorno de resposta de enquete#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": "se for grupo esse será o participante que respondeu",
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"pollVote": {
"pollMessageId": "ID da mensagem de enquete que foi respondida",
"options": [
{
"name": "Z-API"
}
]
},
}

Exemplo de retorno de envio de pedido#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"reviewAndPay": {
"type": "physical-goods",
"currency": "BRL",
"referenceId": "4N9AVI38VOB",
"orderRequestId": "4N9AVI38VYZ",
"orderStatus": "pending",
"paymentStatus": "pending",
"total": 605,
"subTotal": 600,
"discount": 10,
"shipping": 5,
"tax": 10,
"products": [
{
"name": "order 1",
"quantity": 2,
"isCustomItem": true,
"productId": "custom-item-4N9AVI38WI1",
"value": 150
},
{
"name": "order 2",
"quantity": 2,
"isCustomItem": false,
"productId": "23940797548900636",
"value": 150
}
]
}
}

Exemplo de retorno de atualização de pedido#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"reviewOrder": {
"currency": "BRL",
"referenceId": "4N9AVI38VOB",
"orderRequestId": "4N9AVI38VYZ",
"orderStatus": "processing",
"paymentStatus": "pending",
"total": 605,
"subTotal": 600,
"discount": 10,
"shipping": 5,
"tax": 10,
"products": [
{
"name": "order 1",
"quantity": 2,
"isCustomItem": true,
"productId": "custom-item-4N9AVI38WI1",
"value": 150
},
{
"name": "order 2",
"quantity": 2,
"isCustomItem": false,
"productId": "23940797548900636",
"value": 150
}
]
}
}

Exemplo de retorno de convite admin de canal#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"newsletterAdminInvite": {
"newsletterId": "120363166555745933@newsletter",
"newsletterName": "Teste",
"text": "Quero convidar você para ser admin do meu canal no WhatsApp.",
"inviteExpiration": 1706809668
}
}

Exemplo de retorno de fixar mensagem#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": true,
"momment": 1632228955000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"pinMessage": {
"action": "pin",
"pinDurationInSecs": 604800,
"referencedMessage": {
"messageId": "3EB0796DC6B777C0C7CD",
"fromMe": true,
"phone": "554499999999",
"participant": null
}
}
}

Exemplo de retorno de evento#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": true,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "120363019502650977-group",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"event": {
"name": "Nome do evento",
"description": "Descrição do evento",
"canceled": false,
"joinLink": "",
"scheduleTime": 1716915653,
"location": {}
}
}

Exemplo de retorno de resposta de evento#

{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": true,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "120363019502650977-group",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"eventResponse": {
"response": "GOING",
"responseFrom": "554499999999",
"time": 1714423417000,
"referencedMessage": {
"messageId": "D2D612289D9E8F62307D72409A8D9DC3",
"fromMe": false,
"phone": "120363239161320697-group",
"participant": "554499999988"
}
}
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou PUT conforme especificado no inicio deste tópico.

415#

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"


Notification Response#

Conceituação#

As notificações são mensagens de WhatsApp que se baseiam em modelos de mensagens prévias do WhatsApp.

Posto dessa forma, aqui estão documentadas as notificações que recebemos, caso não queira receber essas notificações é necessário ignorar a mensagem quando ela chegar com o atributo notification.

Exemplos#

case 'MEMBERSHIP_APPROVAL_REQUEST':
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Participante " + valor2.notificationparameters + " solicitou participar do grupo<br><br></span>" + campohora + "</div></div>"
break;
case 'GROUP_PARTICIPANT_LEAVE':
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Participante " + valor2.notificationparameters + " saiu do grupo!<br><br></span>" + campohora + "</div></div>"
break;
case 'E2E_ENCRYPTED':
// code block
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>As mensagens são protegidas com a criptografia<br><br></span>" + campohora + "</div></div>"
break;
case 'GROUP_CREATE':
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Criou o grupo \'" + valor2.notificationparameters + "\'<br><br></span>" + campohora + "</div></div>"
break;
case 'GROUP_PARTICIPANT_ADD':
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Participante " + valor2.notificationparameters + " adicionado.<br><br></span>" + campohora + "</div></div>"
break;
case "CALL_MISSED_VOICE":
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Chamada de voz perdida!<br><br></span>" + campohora + "</div></div>"
break
case "CALL_MISSED_VIDEO":
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Chamada de vídeo perdida!<br><br></span>" + campohora + "</div></div>"
break;
case 'GROUP_PARTICIPANT_REMOVE':
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Participante " + valor2.notificationparameters + " foi removido.<br><br></span>" + campohora + "</div></div>"
break;
case "CIPHERTEXT":
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>As mensagens são protegidas com a criptografia de ponta.<br><br></span>" + campohora + "</div></div>"
break;
case "BLUE_MSG_SELF_PREMISE_UNVERIFIED":
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Você está conversando com uma conta comercial, mas ainda não foi confirmada pelo WhatsApp.<br><br></span>" + campohora + "</div></div>"
break;
case "BLUE_MSG_SELF_PREMISE_VERIFIED":
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Você está conversando com uma conta comercial verificada pelo WhatsApp.<br><br></span>" + campohora + "</div></div>"
break;
case "BIZ_MOVE_TO_CONSUMER_APP":
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Esta conta comercial agora está registrada como uma conta pessoal e pode não mais pertencer a uma empresa.<br><br></span>" + campohora + "</div></div>"
break;
case "REVOKE":
campo_html = "<div align='center'><div class='alert alert-primary' role='alert'><span>Apagou uma mensagem.<br><br></span>" + campohora + "</div></div>"
break;