Mensagens de Bot


Webhook de Mensagens de Bot

Configuração: Configurado diretamente na integração do Bot no nexus-chat

Dispara quando uma nova mensagem é encaminhada a um bot integrado ao nexus-chat. Permite integrar sistemas de atendimento automático com a plataforma do Nexus.

Payload

CampoTipoDescrição
event_idstring (uuid)Identificador único do evento (UUID v4).
typestringSempre "message" neste webhook.
messageobjectDados da mensagem recebida.
ticketobjectDados do ticket associado.
whatsappobjectDados do WhatsApp que recebeu a mensagem.
contactobjectDados do contato remetente.
contextobjectVariáveis de contexto personalizadas.

Objeto message

CampoTipoDescrição
idstringID da mensagem no sistema.
fromstringNúmero de origem (cliente).
tostringNúmero de destino (bot/empresa).
from_mebooleanSe foi enviada pelo atendente/bot.
from_botbooleanSe foi enviada por um bot.
user_idinteger | nullID do usuário que enviou.
typestringTipo da mensagem (text, image, etc).
textstringConteúdo textual da mensagem.
postback_textstring | nullTexto de callback de Quick Reply.
filestring | nullURL do arquivo enviado.
datetimestring (date-time)Data e hora do envio.

Objeto ticket

CampoTipoDescrição
idintegerID do ticket.
uuidstringUUID do ticket.
tracking_idintegerCódigo de rastreamento.
campaign_idinteger | nullID da campanha associada.
request_idstring | nullID da requisição original.
cost_center_idinteger | nullID do centro de custo.
statusstringStatus atual do ticket.
user_idinteger | nullID do usuário atendente.
contact_idintegerID do contato.
queue_idintegerID da fila de atendimento.
transfer_queue_idintegerID da fila de transferência.
whatsapp_idintegerID do número do ticket.
integration_idinteger | nullID da integração.
from_mebooleanSe o atendimento foi iniciado pelo sistema.

Objeto whatsapp

CampoTipoDescrição
idintegerID do número de WhatsApp.
namestringNome da empresa/entidade.
numberstringNúmero do WhatsApp.

Objeto contact

CampoTipoDescrição
idintegerID do contato.
namestringNome do contato.
numberstringNúmero de telefone.
documentstring | nullDocumento (CPF/CNPJ).
emailstring | nullEmail do contato.
is_groupbooleanSe é um grupo.
created_atstring (date-time)Data de criação.
updated_atstring (date-time)Data de atualização.
extra_infoarrayLista de dados adicionais.

Exemplo - Mensagem de Texto

{
  "event_id": "j50h2i30-sg2p-g5r8-o150-ii0099ii4444",
  "type": "message",
  "message": {
    "id": "00wamid.HBgMNUMyMDAwMDAwMDAwFQIAEhgUAAAAAAAABBBBCCCCDDDDEEEEFFFF000011112222",
    "from": "559999999999",
    "to": "5511999999999",
    "from_me": false,
    "from_bot": false,
    "user_id": null,
    "type": "text",
    "text": "QUERO MAIS",
    "postback_text": null,
    "file": null,
    "datetime": "2025-07-21T14:54:36.487-03:00"
  },
  "ticket": {
    "id": 12345,
    "uuid": "abcd1234-abcd-1234-abcd-1234567890ab",
    "tracking_id": 987654,
    "campaign_id": 10,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cost_center_id": 1,
    "status": "pending",
    "user_id": null,
    "contact_id": 54321,
    "queue_id": 5,
    "transfer_queue_id": 2,
    "whatsapp_id": 3,
    "integration_id": 1,
    "from_me": false
  },
  "whatsapp": {
    "id": 3,
    "name": "Empresa Fictícia Tecnologia Ltda",
    "number": "5511999999999"
  },
  "contact": {
    "id": 54321,
    "name": "João da Silva",
    "number": "559999999999",
    "document": "00000000000",
    "email": "[email protected]",
    "is_group": false,
    "created_at": "2024-01-01T10:00:00.000Z",
    "updated_at": "2025-07-21T17:54:16.843Z",
    "extra_info": [
      {
        "id": 1,
        "name": "idade",
        "value": "30"
      },
      {
        "id": 2,
        "name": "cidade",
        "value": "São Paulo"
      }
    ]
  },
  "context": {
    "custom_1": "valor1",
    "custom_2": "valor2",
    "custom_3": "valor3"
  }
}

Exemplo - Resposta a Quick Reply

Quando o usuário clica em um botão de Quick Reply, o campo postback_text contém o valor configurado no botão.

{
  "event_id": "l70j4k50-ui4r-i7t0-q372-kk2211kk6666",
  "type": "message",
  "message": {
    "id": "00wamid.HBgMNUMyMDAwMDAwMDAwFQIAEhgUAAAAAAAABBBBCCCCDDDDEEEEFFFF000011112223",
    "from": "559999999999",
    "to": "5511999999999",
    "from_me": false,
    "from_bot": false,
    "user_id": null,
    "type": "text",
    "text": "Suporte Técnico",
    "postback_text": "support",
    "file": null,
    "datetime": "2025-07-21T14:54:36.487-03:00"
  },
  "ticket": {
    "id": 12345,
    "uuid": "abcd1234-abcd-1234-abcd-1234567890ab",
    "tracking_id": 987654,
    "campaign_id": 10,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cost_center_id": 1,
    "status": "pending",
    "user_id": null,
    "contact_id": 54321,
    "queue_id": 5,
    "transfer_queue_id": 2,
    "whatsapp_id": 3,
    "integration_id": 1,
    "from_me": false
  },
  "whatsapp": {
    "id": 3,
    "name": "Empresa Fictícia Tecnologia Ltda",
    "number": "5511999999999"
  },
  "contact": {
    "id": 54321,
    "name": "João da Silva",
    "number": "559999999999",
    "document": "00000000000",
    "email": "[email protected]",
    "is_group": false,
    "created_at": "2024-01-01T10:00:00.000Z",
    "updated_at": "2025-07-21T17:54:16.843Z",
    "extra_info": [
      {
        "id": 1,
        "name": "idade",
        "value": "30"
      }
    ]
  },
  "context": {
    "custom_1": "valor1"
  }
}

Webhook de Mensagens de Bot

Dispara quando uma nova mensagem é encaminhada a um bot integrado ao nexus-chat. Permite integrar sistemas de atendimento automático com a plataforma do Nexus.

Payload

CampoTipoDescrição
event_idstring (uuid)Identificador único do evento (UUID v4).
typestringSempre "message" neste webhook.
messageobjectDados da mensagem recebida.
ticketobjectDados do ticket associado.
whatsappobjectDados do WhatsApp que recebeu a mensagem.
contactobjectDados do contato remetente.
contextobjectVariáveis de contexto personalizadas.

Objeto message

CampoTipoDescrição
idstringID da mensagem no sistema.
fromstringNúmero de origem (cliente).
tostringNúmero de destino (bot/empresa).
from_mebooleanSe foi enviada pelo atendente/bot.
from_botbooleanSe foi enviada por um bot.
user_idinteger | nullID do usuário que enviou.
typestringTipo da mensagem (text, image, etc).
textstringConteúdo textual da mensagem.
postback_textstring | nullTexto de callback de Quick Reply.
filestring | nullURL do arquivo enviado.
datetimestring (date-time)Data e hora do envio.

Objeto ticket

CampoTipoDescrição
idintegerID do ticket.
uuidstringUUID do ticket.
tracking_idintegerCódigo de rastreamento.
campaign_idinteger | nullID da campanha associada.
request_idstring | nullID da requisição original.
cost_center_idinteger | nullID do centro de custo.
statusstringStatus atual do ticket.
user_idinteger | nullID do usuário atendente.
contact_idintegerID do contato.
queue_idintegerID da fila de atendimento.
transfer_queue_idintegerID da fila de transferência.
whatsapp_idintegerID do número do ticket.
integration_idinteger | nullID da integração.
from_mebooleanSe o atendimento foi iniciado pelo sistema.

Objeto whatsapp

CampoTipoDescrição
idintegerID do número de WhatsApp.
namestringNome da empresa/entidade.
numberstringNúmero do WhatsApp.

Objeto contact

CampoTipoDescrição
idintegerID do contato.
namestringNome do contato.
numberstringNúmero de telefone.
documentstring | nullDocumento (CPF/CNPJ).
emailstring | nullEmail do contato.
is_groupbooleanSe é um grupo.
created_atstring (date-time)Data de criação.
updated_atstring (date-time)Data de atualização.
extra_infoarrayLista de dados adicionais.

Exemplo - Mensagem de Texto

{
  "event_id": "j50h2i30-sg2p-g5r8-o150-ii0099ii4444",
  "type": "message",
  "message": {
    "id": "00wamid.HBgMNUMyMDAwMDAwMDAwFQIAEhgUAAAAAAAABBBBCCCCDDDDEEEEFFFF000011112222",
    "from": "559999999999",
    "to": "5511999999999",
    "from_me": false,
    "from_bot": false,
    "user_id": null,
    "type": "text",
    "text": "QUERO MAIS",
    "postback_text": null,
    "file": null,
    "datetime": "2025-07-21T14:54:36.487-03:00"
  },
  "ticket": {
    "id": 12345,
    "uuid": "abcd1234-abcd-1234-abcd-1234567890ab",
    "tracking_id": 987654,
    "campaign_id": 10,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cost_center_id": 1,
    "status": "pending",
    "user_id": null,
    "contact_id": 54321,
    "queue_id": 5,
    "transfer_queue_id": 2,
    "whatsapp_id": 3,
    "integration_id": 1,
    "from_me": false
  },
  "whatsapp": {
    "id": 3,
    "name": "Empresa Fictícia Tecnologia Ltda",
    "number": "5511999999999"
  },
  "contact": {
    "id": 54321,
    "name": "João da Silva",
    "number": "559999999999",
    "document": "00000000000",
    "email": "[email protected]",
    "is_group": false,
    "created_at": "2024-01-01T10:00:00.000Z",
    "updated_at": "2025-07-21T17:54:16.843Z",
    "extra_info": [
      {
        "id": 1,
        "name": "idade",
        "value": "30"
      },
      {
        "id": 2,
        "name": "cidade",
        "value": "São Paulo"
      }
    ]
  },
  "context": {
    "custom_1": "valor1",
    "custom_2": "valor2",
    "custom_3": "valor3"
  }
}

Exemplo - Resposta a Quick Reply

Quando o usuário clica em um botão de Quick Reply, o campo postback_text contém o valor configurado no botão.

{
  "event_id": "l70j4k50-ui4r-i7t0-q372-kk2211kk6666",
  "type": "message",
  "message": {
    "id": "00wamid.HBgMNUMyMDAwMDAwMDAwFQIAEhgUAAAAAAAABBBBCCCCDDDDEEEEFFFF000011112223",
    "from": "559999999999",
    "to": "5511999999999",
    "from_me": false,
    "from_bot": false,
    "user_id": null,
    "type": "text",
    "text": "Suporte Técnico",
    "postback_text": "support",
    "file": null,
    "datetime": "2025-07-21T14:54:36.487-03:00"
  },
  "ticket": {
    "id": 12345,
    "uuid": "abcd1234-abcd-1234-abcd-1234567890ab",
    "tracking_id": 987654,
    "campaign_id": 10,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cost_center_id": 1,
    "status": "pending",
    "user_id": null,
    "contact_id": 54321,
    "queue_id": 5,
    "transfer_queue_id": 2,
    "whatsapp_id": 3,
    "integration_id": 1,
    "from_me": false
  },
  "whatsapp": {
    "id": 3,
    "name": "Empresa Fictícia Tecnologia Ltda",
    "number": "5511999999999"
  },
  "contact": {
    "id": 54321,
    "name": "João da Silva",
    "number": "559999999999",
    "document": "00000000000",
    "email": "[email protected]",
    "is_group": false,
    "created_at": "2024-01-01T10:00:00.000Z",
    "updated_at": "2025-07-21T17:54:16.843Z",
    "extra_info": [
      {
        "id": 1,
        "name": "idade",
        "value": "30"
      }
    ]
  },
  "context": {
    "custom_1": "valor1"
  }
}