Wie man die Papo-API verwendet, um Konversationen aufzulisten und programmatisch Nachrichten zu senden

Mit Papo (https://papo.global/) können Sie die REST-API verwenden, um Konversationen aufzulisten, Textnachrichten zu senden, Tags anzuwenden und Konversationen Agenten zuzuweisen, wodurch Serviceprozesse automatisiert werden, ohne auf die Benutzeroberfläche zugreifen zu müssen. Die API bietet Endpunkte, die die Funktionen des Moduls „Konversationen“ widerspiegeln und es externen Systemen ermöglichen, Interaktionen programmatisch zu verwalten.

Wie die Papo-Konversations-API funktioniert

Die Papo-API folgt dem REST-Standard mit Authentifizierung über einen geheimen Schlüssel (Bearer-Token) und Antworten im JSON-Format. Alle hier beschriebenen Vorgänge verwenden dieselbe Authentifizierungsbasis und können kombiniert werden, um automatisierte Arbeitsabläufe zu erstellen – beispielsweise ein Triage-System, das bei Eingang eines neuen Leads die letzten Konversationen auflistet, ein Tag „Neu“ anwendet und dem diensthabenden Agenten zuweist.

Die API-Basis-URL lautet https://app.papo.global/api/v1. Um die Endpunkte für Konversationen, Tags und Zuweisungen zu verwenden, benötigen Sie ein im Papo-Dashboard generiertes API-Token. Die vollständige Dokumentation mit den spezifischen Endpunkten und Parametern finden Sie unter papo.global/pt/docs.

Schritt-für-Schritt-Anleitung zur Nutzung der API-Funktionen

1. Generieren Sie ein API-Token

Greifen Sie im Papo-Dashboard auf den Entwicklerbereich oder die Zugriffstoken zu. Erstellen Sie einen geheimen Schlüssel (sk_live_…) mit den entsprechenden Berechtigungen zur Verwaltung von Konversationen. Bewahren Sie das Token an einem sicheren Ort auf – es wird im Header Authorization aller Anfragen gesendet.

2. Konversationen auflisten

Verwenden Sie den Endpunkt zum Auflisten von Konversationen, um die Vorgänge des Kontos abzurufen. Die Anfrage akzeptiert Filterparameter wie:

• Status: offene, geschlossene oder alle Konversationen.
• Tag: filtert nach einem oder mehreren angewendeten Tags.
• Agent: beschränkt auf Konversationen, die einem bestimmten Benutzer zugewiesen sind.
• Zeitraum: Datumsbereich zur Eingrenzung der Abfrage.

Die Antwort enthält die Konversations-ID, den Kontakt, den Kanal, den Status und die letzten Nachrichten. Mit diesen Daten können Sie das Volumen der Vorgänge überwachen oder bedingte Aktionen aus einem externen System auslösen.

3. Senden Sie eine Textnachricht

Um eine Textnachricht an einen Kontakt zu senden, verwenden Sie den Endpunkt zum Senden von Nachrichten. Die Anfrage erfordert:

• Empfängernummer im internationalen Format (z. B. 5511999999999).
• Nachrichtentext.
• Instanz-ID (optional) – falls Ihr Konto mehr als eine WhatsApp-Verbindung hat, können Sie angeben, welche verwendet werden soll.

Die API gibt eine Bestätigung zurück, dass die Anfrage akzeptiert wurde. Beachten Sie, dass das Senden von Textnachrichten dem 24-Stunden-Fenster von WhatsApp unterliegt; für Kommunikation außerhalb dieses Zeitraums müssen vorab genehmigte Nachrichtenvorlagen (HSM) verwendet werden.

4. Tags auf Kontakte und Konversationen anwenden

Die API ermöglicht die Verwaltung von Tags auf zwei Arten:

• Ein Tag im Konto erstellen: Legen Sie einen Titel, eine Farbe und eine Beschreibung für das neue Tag fest.
• Ein Tag anwenden: Verknüpfen Sie ein vorhandenes Tag mit einem Kontakt und der offenen Konversation dieses Kontakts. Wenn das Tag noch nicht existiert, wird es während der Anwendung automatisch erstellt.

Dies ist nützlich, um Konversationen automatisch basierend auf Regeln Ihres Systems zu klassifizieren – beispielsweise als „Beschwerde“ zu markieren, wenn der Kunde ein bestimmtes Schlüsselwort sendet.

5. Konversationen Agenten zuweisen

Mit dem Zuweisungsendpunkt können Sie einen Agenten für alle offenen Konversationen eines bestimmten Kontakts bestimmen. Geben Sie einfach die Kontakt-ID und die Benutzer-/Agenten-ID an. Die Liste der Agenten des Kontos kann über den Endpunkt zum Auflisten von Benutzern abgerufen werden, der Name, E-Mail und ID jedes Teammitglieds zurückgibt.

Diese Funktion ist für automatisches Routing unerlässlich: Ein CRM-System kann beim Identifizieren des Lead-Profils diesen ohne manuellen Eingriff dem richtigen Vertriebsmitarbeiter zuweisen.

Wer sollte die Konversations-API verwenden

• Betriebe, die bereits externe Systeme nutzen (ERP, CRM, E-Commerce-Plattformen) und den Papo-Kundenservice integrieren möchten, ohne doppelte Arbeit zu leisten.
• Support-Teams mit komplexen Routing-Regeln, die Konversationen automatisch basierend auf Kundendaten klassifizieren und weiterleiten müssen.
• Entwickler, die benutzerdefinierte Dashboards erstellen oder Benachrichtigungen aus Service-Ereignissen auslösen.
• White-Label-Reseller, die mehrere Konten verwalten und die Konfiguration von Tags und Zuweisungen für jeden Kunden automatisieren möchten.

Häufig gestellte Fragen

Benötige ich ein API-Token, um diese Endpunkte zu verwenden?

Ja. Alle Anfragen an die Papo-API erfordern eine Authentifizierung über einen geheimen Schlüssel, der im Header Authorization: Bearer sk_live_… gesendet wird. Token werden im Konto-Dashboard generiert.

Erlaubt die API das Senden von Nachrichten außerhalb des 24-Stunden-Fensters von WhatsApp?

Das Senden von Textnachrichten über die API respektiert das 24-Stunden-Fenster. Für proaktive Kommunikation außerhalb dieses Zeitraums müssen genehmigte Nachrichtenvorlagen (HSM) verwendet werden. Papo bietet spezifische Endpunkte für das Senden von HSM.

Kann ich Konversationen nach Tag auflisten?

Ja. Der Endpunkt zum Auflisten von Konversationen akzeptiert einen Filter nach Tag, sodass Sie nur die Vorgänge abrufen können, die mit einem oder mehreren bestimmten Tags markiert sind.

Wie wende ich ein Tag auf einen Kontakt über die API an?

Verwenden Sie den Tag-Endpunkt, geben Sie die Tag-ID (oder die Daten zur Erstellung) und die Kontakt-ID an. Das Tag wird auf den Kontakt und die entsprechende offene Konversation angewendet.

Gibt die API den vollständigen Konversationsverlauf zurück?

Die Auflistung von Konversationen gibt die Metadaten und die letzten Nachrichten zurück. Um den vollständigen Nachrichtenverlauf einer bestimmten Konversation zu erhalten, konsultieren Sie die API-Dokumentation, die die Endpunkte zum Abrufen von Nachrichten detailliert beschreibt.

Ist es möglich, eine Konversation einem Agenten zuzuweisen, ohne die Benutzer-ID zu kennen?

Sie können zuerst die Benutzer des Kontos auflisten (Agenten-Endpunkt), um die IDs zu erhalten, und dann den Zuweisungsendpunkt verwenden. Die Agentenliste enthält Name und E-Mail, was die Identifizierung erleichtert.

Lesen Sie auch

• Wie man die Papo-API verwendet, um Kunden Ihres White-Label-Resellers zu verwalten
• Wie man die Papo-API verwendet, um benutzerdefinierte Kontaktattribute zu verwalten

Kostenlos starten →

Testen Sie die API und alle Module von Papo kostenlos – der erste Benutzer ist kostenlos und erfordert keine Kreditkarte.