Depois de configurar um Webhook personalizado, você receberá a carga dos seus endpoints. Aqui estão as definições para cada coluna
chat_id
Quando a mensagem vem de uma mensagem individual, os números de telefone de ambos os grupos serão exibidos como a ID do chat, xxxxxxxxxxx_xxxxxxxxxx@c. s. Se a mensagem for de uma mensagem de grupo, o ID do chat do grupo do WhatsApp, [email protected]será exibido.
chat_type
Indique se é um chat individual ou um chat em grupo.
chat_title
O nome de exibição do chat. Em uma conversa de 1:1, será o nome salvo do contato ou o número de telefone do contato. Em uma conversa em grupo, o título do grupo será o nome do grupo.
sender.phone / sender.wa_name
Se a direção da mensagem for "enviada", o campo de contato será você. Se a direção da mensagem for "recebida", o campo de contato será seu cliente.
Estes campos representam o número de telefone e o nome do WhatsApp.
participantes.telefone / participantes.wa_name
Esta coluna lista TODOS os participantes neste grupo, Juntamente com seus números de telefone e nomes do WhatsApp, incluindo o atual usuário do Cooby.
user_phone
Este campo indica o número de telefone do usuário logado atualmente.
user_email
Este campo indica o email do usuário que está logado no sistema.
direction
Esta coluna indica a direção da mensagem em referência ao usuário do Cooby.
message.id
Números de ID exclusivos permitem que você identifique cada mensagem
message.type
Devido a limitações do WhatsApp, qualquer tipo de imagem (.png, . pg) só será exibido como o tipo de arquivo de imagem, e a mesma limitação se aplica a vídeos e outros tipos de documentos por padrão.
No entanto, para arquivos no formato .pdf, .csv, ou .doc , o tipo de arquivo original será exibido no payload. Para outros tipos de documentos, ele permanecerá como o documento .
message.text
Esta coluna contém o conteúdo da mensagem.
Apenas mensagens de bate-papo, imagem, vídeo e documentos têm texto na forma de mensagem de texto; outros tipos não terão um campo de texto
nome_mensagem.arquivo
Para pdf, csv, doc, e outros tipos de documentos, o nome original do arquivo será exibido.
Para imagem, vídeo, áudio e adesivos, o nome do arquivo será exibido como Cooby ##{{message_type}} ##{{date}} ao ##{{time}}
message.file_url
Nós mostraremos um link url para baixar o arquivo.
Cooby suporta apenas arquivos multimídia de até 15 MB
message.caption
Se um anexo tiver legenda, o texto será exibido em ambos message.text e message.caption. Se houver apenas um anexo sem texto, tanto message.text quanto message.caption será uma string vazia.
message.is_error / message.error_code / message.error_messages
Abaixo estão os códigos de erro da mensagem e as respectivas mensagens de erro 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 quando a mensagem foi enviada.
Payload example
{
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 lhe ajude a entender melhor como o Cooby funciona. Para quaisquer preocupações ou perguntas sobre a integração do seu Webhook personalizado, envie um email para [email protected]💜