Definições das colunas do Webhook

Após configurar um Webhook Personalizado, você receberá o payload dos seus endpoints. Aqui estão as definições para cada coluna.

chat_id

Quando a mensagem for individual, os números de telefone de ambas as partes serão exibidos como chat ID, no formato xxxxxxxxxxx_xxxxxxxx@c.us. Se for uma mensagem de grupo, será exibido o chat ID do grupo do WhatsApp, no formato 120363041306185221@g.us.

chat_type

Indica se é um chat individual ou um chat em grupo.

chat_title

Nome exibido do chat. Em uma conversa 1:1, será o nome salvo do contato ou o número de telefone. Em um chat em grupo, será o nome do grupo.

sender.phone / sender.wa_name

Se a direção da mensagem for "sent", o campo de contato será você; se for "received", será o seu cliente.

Esses campos representam o número de telefone e o nome do WhatsApp do remetente.

participants.phone / participants.wa_name

Esta coluna lista TODOS os participantes do chat, com seus números de telefone e nomes no WhatsApp, incluindo o usuário atual do Cooby.

user_phone

Este campo indica o número de telefone do usuário atual do Cooby.

user_email

Este campo indica o e-mail do usuário atual do Cooby.

direction

Esta coluna indica a direção da mensagem em relação ao usuário do Cooby.

message.id

IDs únicos que permitem identificar cada mensagem.

message.type

Devido às limitações do WhatsApp, tipos de imagem (.png, .jpg) serão exibidos apenas como tipo de arquivo de imagem, o mesmo vale para vídeos e outros documentos por padrão. Para arquivos .pdf, .csv ou .doc, o tipo de arquivo original será exibido no payload. Outros documentos serão exibidos como tipo "document".

message.text

Esta coluna contém o conteúdo da mensagem.

message.file_name

Para arquivos pdf, csv, doc e outros documentos, o nome original será exibido.

Para imagens, vídeos, áudios e figurinhas, o nome será exibido como  Cooby {{message_type}} {{date}} at {{time}}

message.file_url

Será exibido um link de URL para download do arquivo.

message.caption

Se o anexo tiver uma legenda, o texto será exibido tanto em message.text quanto em message.caption. Se houver apenas um anexo sem texto, ambos os campos ficarão vazios.

message.is_error / message.error_code / message.error_messages

Abaixo estão os códigos de erro de mensagem e suas mensagens correspondentes suportadas nesta atualização:

message.error_code        message.error_message
"file_size_out_of_limit": "[File size out of limit. Max file size supported by Cooby is 15MB.]",
"file_not_found":         "[File not found.]",
"file_expired":           "[File has expired.]",
"file_unsupported":       "[File type unsupported.]",
"invalid_file_type":      "[Invalid file type.]",
"unknown_error":          "[Unknown error.]",

timestamp

Esta coluna exibe a data e hora (UTC) em que a mensagem foi enviada.

Exemplo de Payload

{
  chat_id: "447441369136_447441368384@c.us";
  chat_type: "individual";
  chat_title: "Sarah Brown";
  user_phone: "447441368384";
  user_email: "support@cooby.co";
  direction: "sent";
  message: {
    id: "3EB093D273669B3BE3D2";
    type: "chat";
    text: "Hi, welcome to Cooby!";
    file_name: "Cooby Image 2023-07-12 at 11.13.32 AM";
    file_url: "https://api.cooby.co/v2/files/xxxxx";
    caption: "Hi, welcome to Cooby!";
    is_error: false;
    error_code: null;
    error_message: null;
  };
  timestamp: "1628843453";
  participants: [
   {
    phone: "447441369136";
    wa_name: "Sarah Brown";
   },
   { 
    phone: "447441368384", 
    wa_name: "Cooby" 
   } 
  ],
  sender: {
    phone: "447441368384";
    wa_name: "Cooby";
  };
}

Esperamos que este documento ajude você a entender melhor como funciona o Cooby. Se tiver dúvidas ou questões sobre a integração com Webhook Personalizado, entre em contato pelo e-mail support@cooby.co 💜

Actualizado em: 18/06/2025