Konten in der API und Autorisierungssitzungen
Ein Konto ist ein verbundenes Messenger-Konto, von dem aus der NN Agent schreibt und liest. Die Verbindung erfolgt über eine Autorisierungssitzung: Sie öffnen eine Sitzung, der Messenger sendet einen Code, Sie übergeben den Code in die Sitzung.
Alle Anfragen erfordern ein Bearer-Token, siehe Autorisierung.
Autorisierungssitzungen#
/v2/accounts/auth-sessionsÖffnen Sie eine Autorisierungssitzung mit der Telefonnummer. Gibt die Sitzungs-ID zurück, an die der Code und das Passwort gebunden sind. Der Anfrageinhalt ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/accounts/auth-sessions/qrÖffnen Sie eine Autorisierungssitzung mit einem QR-Code — eine Alternative zum Code aus der Nachricht. Der Anfrageinhalt ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/accounts/auth-sessions/{auth_id}Sitzungsstatus: wartet auf Code, wartet auf Passwort, abgeschlossen, abgelehnt. Abfragen Sie diese Operation zwischen den Verbindungsschritten.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
UUID der Autorisierungssitzung
/v2/accounts/auth-sessions/{auth_id}/codeBestätigungscode übermitteln, den der Messenger an die Nummer gesendet hat. Der Anfrageinhalt ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
UUID der Autorisierungssitzung
/v2/accounts/auth-sessions/{auth_id}/passwordÜbertragen Sie das Cloud-Passwort, wenn die Zwei-Faktor-Authentifizierung für das Konto aktiviert ist. Der Anfrageinhalt ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet – er wird niemals an Docsbook gesendet oder gespeichert.
UUID der Autorisierungssitzung
/v2/accounts/auth-sessions/{auth_id}/resend-codeFordern Sie eine erneute Zusendung des Bestätigungscodes an.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet – er wird niemals an Docsbook gesendet oder gespeichert.
UUID der Autorisierungssitzung
/v2/accounts/auth-sessions/{auth_id}Beenden Sie die nicht abgeschlossene Autorisierungssitzung.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet – er wird niemals an Docsbook gesendet oder gespeichert.
UUID der Autorisierungssitzung
Schritt-für-Schritt-Anleitung zu dieser Sequenz – Konto über API verbinden.
Konten#
/v2/accountsListe der verbundenen Konten des Kunden. Der Kunde wird durch das Token identifiziert.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/accounts/{account_id}Karte eines einzelnen Kontos.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
UUID des Kontos
/v2/accounts/{account_id}/updateÄndern Sie die Kontoeinstellungen. Der Anfragekörper ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
UUID des Kontos
/v2/accounts/{account_id}Trennen Sie das Konto von NN Agent.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
UUID des Kontos
Verknüpfung von Konten mit der Kampagne#
Konten versenden von sich aus nichts — sie werden mit der Kampagne verknüpft. Die Vorgänge der Verknüpfung und Trennung sind auf der Seite Kampagnen und Kontakte beschrieben.
Weiter#
- API-Konto verbinden — vollständige Aufrufreihenfolge.
- Dialoge — was nach der Verbindung zu lesen und zu senden ist.
- Multi-Accounting — dieselbe Mechanik im Dashboard.