Después de configurar un webhook personalizado, recibirás la carga útil de tus extremos. Aquí están las definiciones de cada columna

chat_id

Cuando el mensaje viene de un mensaje individual, los números de teléfono de ambas partes se mostrarán como el ID del chat, [email protected]. Si el mensaje viene de un mensaje de grupo, se mostrará el ID del chat del grupo WhatsApp, [email protected].

chat_type

Indique si es un chat individual o un chat de grupo.

chat_title

El nombre a mostrar del chat. En un chat de 1:1, será el nombre guardado del contacto o el número de teléfono del contacto. En un chat de grupo, el título del chat será el nombre del grupo.

sender.phone / sender.wa_name

Si la dirección del mensaje es "enviado", el campo de contacto será tú; si la dirección del mensaje es "recibida", el campo de contacto será su cliente.

Estos campos representan el número de teléfono del remitente y el nombre de WhatsApp.

participants.phone / participants.wa_name

Esta columna enumera 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 actual del usuario de Cooby.

user_email

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

direction

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

message.id

Números de identificación únicos te permiten identificar cada mensaje

message.type

Debido a las limitaciones de WhatsApp, cualquier tipo de imagen (.png, . pg) sólo se mostrará como el tipo de archivo de imagen, y la misma limitación se aplica por defecto al vídeo y a otros tipos de documentos.

Sin embargo, para los archivos en formato .pdf, .csv, o .doc, el tipo de archivo original se mostrará en la carga útil. Para otros tipos de documentos, permanecerá como documento.

message.text

Esta columna contiene el contenido del mensaje.

Sólo los tipos de chat, imagen, vídeo y mensajes de documento tienen texto en forma de texto del mensaje; otros tipos no tendrán un campo de texto

message.file_name

Para pdf, csv, doc, y otros tipos de documentos, se mostrará el nombre del archivo original.

Para imágenes, video, audio y pegatinas, el nombre del archivo se mostrará como Cooby ##{{message_type}} ##{{date}} en ##{{time}}

message.file_url

Le mostraremos un enlace de la url para que descargue el archivo.

Cooby sólo soporta archivos multimedia de hasta 15 MB

message.caption

Si un archivo adjunto tiene un subtítulo, el texto se mostrará en message.text y message.caption. Si solo hay un archivo adjunto sin texto, tanto message.text como message.caption serán una cadena vacía.

message.is_error / message.error_code / message.error_messages

A continuación se muestran los códigos de error del mensaje y sus correspondientes mensajes de error soportados 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 de UTC cuando el mensaje fue enviado.

Payload ejemplo

{
  chat_id: "[email protected]";
  chat_type: "individual";
  chat_title: "Sarah Brown";
  user_phone: "447441368384";
  user_email: "[email protected]";
  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 le ayude a entender mejor cómo funciona Cooby. Para cualquier duda o duda sobre su integración personalizada de Webhook, escríbanos a [email protected]💜