Mit der REST-API von Papo können Sie vorhandene Etiketten auflisten, neue Etiketten erstellen und ein Etikett auf einen Kontakt mit offener Konversation anwenden – alles über authentifizierte Anfragen, ohne das Dashboard zu öffnen. Dies ist der programmatische Weg, um die Kategorisierung und Organisation des Services aus externen Systemen, CRMs oder Automatisierungstools zu automatisieren.
Die Papo-API stellt Konversationsressourcen bereit, die die Verwaltung von Etiketten umfassen. Damit kann Ihr Team eine konsistente Taxonomie beibehalten, Kategorien vor Kampagnen vorbereiten und Kontakte und Konversationen in Echtzeit klassifizieren, wobei dieselbe Authentifizierung wie bei den anderen Endpunkten der Plattform verwendet wird.
Zusammenfassung der Etikettoperationen über die API
| Operation | Was sie bewirkt | Wann sie verwendet wird |
|---|---|---|
| Etiketten auflisten | Gibt die im Konto registrierten Etiketten mit Name und Farbe zur visuellen Identifikation zurück. | Überprüfen der Standardisierung des Kontos oder Synchronisieren von Etiketten mit einem anderen Tool. |
| Etikett erstellen | Erstellt ein Etikett im Konto, ohne es auf einen Kontakt anzuwenden. | Vorbereiten neuer Kategorien vor der Massenanwendung oder in Automatisierungen. |
| Etikett auf Kontakt + Konversation anwenden | Erstellt das Etikett, falls es noch nicht existiert, und wendet es auf den Kontakt und die offene Konversation an. | Automatisieren Sie die Triage, Qualifizierung oder Klassifizierung, sobald die Konversation eingeht. |
Wie die API-Authentifizierung funktioniert
Alle Schreibrotten, einschließlich der Etikettoperationen, erfordern den geheimen Schlüssel des Kontos. Dieser muss als Bearer-Token im Autorisierungsheader gesendet werden. Der öffentliche Schlüssel des Kontos ist optional, muss aber, wenn er gesendet wird, mit demselben Konto wie der geheime Schlüssel übereinstimmen.
Die Basis-URL der API ist https://app.papo.global/api/v1. Die Schlüssel werden im Entwicklerbereich des Papo-Dashboards generiert. Der geheime Schlüssel wird bei der Erstellung nur einmal angezeigt; bewahren Sie ihn an einem sicheren Ort auf und widerrufen Sie ihn bei Verdacht auf Offenlegung.
Praktische Anwendung
- Rufen Sie den Entwickler-/API-Bereich im Papo-Dashboard auf und generieren Sie einen geheimen Schlüssel. Kopieren Sie auch den öffentlichen Schlüssel des Kontos.
- Authentifizieren Sie sich bei jeder Anfrage mit dem geheimen Schlüssel als Bearer-Token. Wenn Sie die Validierung verstärken möchten, senden Sie den öffentlichen Schlüssel im in der Dokumentation angegebenen Header.
- Um Etiketten aufzulisten, rufen Sie den Endpunkt zum Auflisten von Etiketten der API auf. Die Antwort enthält die registrierten Etiketten, sodass Sie vor dem Erstellen neuer Etiketten eine Bestandsaufnahme machen können.
- Um ein Etikett zu erstellen, ohne es anzuwenden, senden Sie einen JSON-Payload mit den Etikettinformationen an den Erstellungsendpunkt. Konsultieren Sie die offizielle Dokumentation für das genaue Format.
- Um ein Etikett auf einen Kontakt mit offener Konversation anzuwenden, rufen Sie den Etikettierungsendpunkt auf. Wenn das Etikett noch nicht existiert, wird es automatisch erstellt und auf den Kontakt und die offene Konversation angewendet.
Da die API REST ist und JSON verwendet, kann jede Sprache mit HTTP-Unterstützung verwendet werden, um Etiketten in Skripte, ERPs, CRMs oder Automatisierungstools zu integrieren. Die offizielle Dokumentation unter https://papo.global/pt/docs enthält Details zur Authentifizierung, Parameter, Antworten und Codebeispiele.
Für wen diese Integration sinnvoll ist
- Teams, die externe Automatisierungen verwenden, um Konversationen zu klassifizieren, ohne die Papo-Oberfläche zu öffnen.
- Betriebe, die Etiketten in großem Umfang erstellen müssen, vor Kampagnen oder bei der Implementierung einer neuen Service-Taxonomie.
- Integratoren und White-Label-Wiederverkäufer, die Papo mit Kundensystemen verbinden und eine konsistente Kategorisierung zwischen den Konten beibehalten möchten.
- Unternehmen, die die Papo-API bereits für Kontakte und Nachrichten nutzen und den Workflow mit Etiketten vervollständigen möchten.
Häufig gestellte Fragen
Muss ich das Etikett erstellen, bevor ich es über die API anwende?
Nein. Die API verfügt über eine Funktion, die das Etikett im Konto erstellt, falls es noch nicht vorhanden ist, und es direkt auf den Kontakt und die offene Konversation anwendet. Es gibt auch die Option, das Etikett nur zu erstellen, ohne es auf einen Kontakt anzuwenden.
Gilt das über die API angewendete Etikett für den Kontakt und die Konversation?
Ja. Die Etikettierungsfunktion wendet das Etikett auf den Kontakt und die offene Konversation an und hilft dabei, sowohl den Verlauf des Leads als auch den laufenden Service zu klassifizieren.
Ist die Authentifizierung dieselbe wie bei anderen Papo-Endpunkten?
Ja. Die Schreibrouten erfordern den geheimen Schlüssel des Kontos, der als Bearer-Token gesendet wird. Der öffentliche Schlüssel ist optional und muss, wenn er gesendet wird, mit demselben Konto übereinstimmen.
Wo finde ich die genauen Pfade und das Payload-Format?
In der offiziellen API-Dokumentation, verfügbar unter https://papo.global/pt/docs. Dort finden Sie Details zur Authentifizierung, Parameter, Antworten und Codebeispiele für Etiketten und andere Ressourcen.
Kann ich die API verwenden, um alte Konversationen in großem Umfang zu klassifizieren?
Die beschriebene Anwendungsfunktion der Plattform wirkt auf den Kontakt und die offene Konversation. Für spezifische Migrations- oder retroaktive Klassifizierungsfälle ist es ideal, die offizielle Dokumentation zu konsultieren und die Auflistung von Konversationen mit sequenziellen Aufrufen zu kombinieren, wenn der Workflow dies zulässt.
Lesen Sie auch
- So verwenden Sie die Papo-API zum Erstellen und Aktualisieren von Kontakten in großem Umfang
- So verwenden Sie die Papo-API zum Senden von WhatsApp-Nachrichtenvorlagen (HSM)
Erstellen Sie Ihr kostenloses Konto und zentralisieren Sie WhatsApp, Instagram, E-Mail und SMS in einem einzigen Posteingang, mit Etiketten zur Organisation des Services.