Nach dem Einrichten eines benutzerdefinierten Webhooks erhalten Sie die Payload von Ihren Endpunkten. Hier sind die Definitionen für jede Spalte
chat_id
Wenn die Nachricht von einer einzelnen Nachricht kommt, die Telefonnummern beider Parteien werden als Chat-ID angezeigt, xxxxxxxxx_xxxxxx@c. s. Wenn die Nachricht von einer Gruppennachricht kommt, wird die WhatsApp Gruppenchat ID [email protected]angezeigt.
chat_type
Geben Sie an, ob es sich um einen individuellen Chat oder einen Gruppenchat handelt.
chat_title
Der Anzeigename des Chats. In einem 1:1 Chat wird es der gespeicherte Name des Kontakts oder die Telefonnummer des Kontakts sein. In einem Gruppenchat wird der Chat-Titel der Name der Gruppe sein.
sender.phone / sender.wa_name
Wenn die Nachrichtenrichtung "gesendet" ist, wird das Kontaktfeld Sie sein; wenn die Nachrichtenrichtung "empfangen" ist, wird das Kontaktfeld Ihr Kunde sein.
Diese Felder repräsentieren die Telefonnummer des Absenders und den WhatsApp-Namen.
participants.phone / participants.wa_name
Diese Spalte listet ALLE Teilnehmer an diesem Chat auf, zusammen mit ihren Telefonnummern und WhatsApp Namen, einschließlich des aktuellen Cooby Benutzers.
user_phone
Dieses Feld zeigt die derzeit eingeloggte Cooby-Benutzer-Telefonnummer an.
user_email
Dieses Feld zeigt die aktuelle eingeloggte Cooby-Benutzer-E-Mail an.
direction
Diese Spalte zeigt die Richtung der Nachricht in Bezug auf den Cooby Benutzer an.
message.id
Eindeutige ID-Nummern erlauben es Ihnen, jede Nachricht zu identifizieren.
message.type
Aufgrund von WhatsApp Einschränkungen ist jeder Bildtyp (.png, . pg) wird nur als Bilddateityp angezeigt, und die gleiche Einschränkung gilt standardmäßig für Video- und andere Dokumententypen.
Für Dateien im .pdf, .csv oder .doc Format wird der ursprüngliche Dateityp jedoch in der Payload angezeigt. Für andere Dokumenttypen bleibt es als Dokument.
message.text
Diese Spalte enthält den Inhalt der Nachricht.
Nur Chat-, Bild-, Video- und Dokumententypen haben Text in Form von Nachrichtentexten; andere Typen haben kein Textfeld
message.file_name
Für pdf, csv, doc und andere Dokumenttypen wird der ursprüngliche Dateiname angezeigt.
Für Bilder, Video, Audio und Aufkleber wird der Dateiname als Cooby ##{{message_type}} ##{{date}} unter ##{{time}} angezeigt
message.file_url
Wir zeigen Ihnen einen Url-Link zum Download der Datei.
Cooby unterstützt nur Multimedia-Dateien bis zu 15 MB
message.caption
Wenn ein Anhang Untertitel hat, wird der Text sowohl in message.text als auch message.caption angezeigt. Wenn es nur einen Anhang ohne Text gibt, wird ein leerer String sein, sowohl message.text als auch message.caption.
message.is_error / message.error_code / message.error_messages
Unten sind die Fehlercodes und die entsprechenden Fehlermeldungen in diesem Update unterstützt:
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
Diese Spalte zeigt das UTC-Datum und die Uhrzeit an, an der die Nachricht gesendet wurde.
Payload Beispiel
{
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";
};
}Wir hoffen, dass dieses Dokument Ihnen hilft, besser zu verstehen, wie Cooby funktioniert. Für alle Bedenken oder Fragen bezüglich Ihrer benutzerdefinierten Webhook-Integration senden Sie uns bitte eine E-Mail an [email protected]💜