received_message

Evento disparado após recebimento de mensagem.

Exemplo

JSON

{
  "event": "received_message", // String. Tipo de evento, neste caso, recebimento de mensagem.
  "event_ts": "2025-03-17T20:19:25.448158", // String. Timestamp do evento no formato ISO 8601.
  "message_data": {
    "alt_message": null, // String | null. Versão alternativa da mensagem, se houver.
    "ctwa_context_url": null, // String | null. URL de contexto de Call To WhatsApp (CTWA), se aplicável.
    "delete_message": false, // Boolean. Indica se a mensagem foi marcada para exclusão.
    "deleted_at": null, // String | null. Timestamp da exclusão da mensagem, se aplicável.
    "edited": false, // Boolean. Indica se a mensagem foi editada.
    "error": false, // Boolean. Indica se houve erro no envio ou processamento da mensagem.
    "error_message": null, // String | null. Mensagem de erro, se houver.
    "fav": false, // Boolean. Indica se a mensagem foi marcada como favorita.
    "fav_user_id": null, // String | null. ID do usuário que favoritou a mensagem, se aplicável.
    "file_type": null, // String | null. Tipo de arquivo, se a mensagem for uma mídia.
    "final_send": true, // Boolean. Indica se a mensagem foi enviada com sucesso.
    "from_me": false, // Boolean. Indica se a mensagem foi enviada pelo usuário do sistema (true) ou recebida de um contato externo (false).
    "id": "ID131231231", // String. ID único da mensagem.
    "ignore": false, // Boolean. Indica se a mensagem deve ser ignorada.
    "instance_id": "chatpro-fz5qbe2haz", // String. ID da instância do sistema de chat.
    "is_forwarded": false, // Boolean. Indica se a mensagem foi encaminhada de outra conversa.
    "lead_id": "INVALID-UUID-123", // String. ID do lead (cliente) associado à mensagem.
    "message": "Pode ser o horário das 09h e o das 10h", // String. Conteúdo da mensagem recebida.
    "number": "[e-mail]", // String. Número de telefone do remetente da mensagem.
    "page_count": null, // Integer | null. Número de páginas, caso seja um documento enviado.
    "participant": "[e-mail]", // String. Identificação do participante na conversa, geralmente o mesmo que `number`.
    "payload": null, // JSON | null. Dados adicionais associados à mensagem, se houver.
    "quoted_message_id": "", // String. ID da mensagem citada em resposta, se aplicável.
    "reactions": null, // JSON | null. Reações à mensagem, se houver.
    "read": false, // Boolean. Indica se a mensagem foi lida pelo destinatário.
    "session_id": "INVALID-UUID-123", // String. ID da sessão de conversa associada à mensagem.
    "status": 2, // Integer. Status da mensagem (exemplo:-1 = error no envio, 0 = enviando,  1 = enviada, 2 = entregue, 3 = lida).
    "title": null, // String | null. Título da mensagem, se aplicável (exemplo: nome do arquivo em uma mídia).
    "ts_receive": "2025-03-17T20:19:25+01:00", // String. Timestamp de recebimento da mensagem.
    "type": "receveid_message", // String. Tipo da mensagem, indicando que foi recebida.
    "url": null, // String | null. URL associada à mensagem, se aplicável (por exemplo, para arquivos ou mídia).
    "user_action_id": null, // String | null. ID da ação do usuário associada à mensagem, se houver.
    "user_read_id": null // String | null. ID do usuário que marcou a mensagem como lida, se aplicável.
  }
}