Definiciones de las columnas de Webhook

Después de configurar un Webhook personalizado, recibirás el payload desde tus endpoints. Aquí están las definiciones de cada columna.

chat_id

Cuando el mensaje proviene de un chat individual, se mostrará el número de teléfono de ambas partes como chat ID.** xxxxxxxxxxx_xxxxxxxx@c.us.**
Si proviene de un chat grupal, se mostrará el chat ID 120363041306185221@g.us del grupo de WhatsApp. 

chat_type

Indica si es un chat individual o un chat grupal.

chat_title

El nombre mostrado del chat. En un chat 1:1, será el nombre guardado del contacto o su número de teléfono. En un chat grupal, será el nombre del grupo.

sender.phone / sender.wa_name

Si la dirección del mensaje es "enviado", el campo de contacto será tú mismo; si es "recibido", será tu cliente. Estos campos representan el número de teléfono y el nombre de WhatsApp del remitente.

participants.phone / participants.wa_name

Esta columna muestra TODOS los participantes en este chat, junto con sus números de teléfono y nombres de WhatsApp, incluido el usuario actual de Cooby.

user_phone

Este campo indica el número de teléfono del usuario actual de Cooby.

user_email

Este campo indica el correo electrónico del usuario actual de Cooby.

direction

Esta columna indica la dirección del mensaje en referencia al usuario de Cooby.

message.id

Los números de ID únicos te permiten identificar cada mensaje.

message.type

Debido a las limitaciones de WhatsApp, cualquier tipo de imagen (.png, .jpg) solo se mostrará como tipo de archivo de imagen; esta misma limitación se aplica a videos y otros documentos por defecto.

Sin embargo, para archivos en formato .pdf, .csv o .doc, el tipo de archivo original se mostrará en el payload. Para otros tipos de documento, permanecerá como document.

message.text

Esta columna contiene el contenido del mensaje.

Solo los tipos de mensaje de chat, imagen, video y documento tienen texto en el campo message.text; otros tipos no tendrán un campo de texto.

message.file_name

Para archivos pdf, csv, doc y otros tipos de documento, se mostrará el nombre original. Para imagen, video, audio y stickers, el nombre del archivo se mostrará como Cooby {{ message_type }} {{ date }} at {{ time }}.

message.file_url

Mostraremos un enlace URL para que descargues el archivo.

Cooby solo admite archivos multimedia de hasta 15 MB

message.caption

Si un archivo adjunto tiene un título, el texto se mostrará en message.text y message.caption. Si es solo un archivo adjunto sin texto, ambos estarán vacíos.

message.is_error / message.error_code / message.error_messages

A continuación se muestran los códigos de error de los mensajes y sus mensajes de error correspondientes en esta actualización:

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 columna muestra la fecha y hora en UTC en que se envió el mensaje.

Ejemplo 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 te ayude a comprender mejor cómo funciona Cooby. Si tienes alguna duda o pregunta sobre tu integración de Webhook personalizado, por favor contáctanos en support@cooby.co 💜

Actualizado el: 18/06/2025