Wie man ein Messenger-Konto über die API verbindet
Die Verbindung eines Kontos mit dem NN Agent über die API erfolgt über eine Autorisierungssitzung: Sie öffnen eine Sitzung, der Messenger sendet einen Code an die Nummer, Sie geben den Code zurück in die Sitzung ein. Bei aktivierter Zwei-Faktor-Authentifizierung wird ein weiterer Schritt hinzugefügt – das Cloud-Passwort.
Bevor Sie beginnen, erhalten Sie ein Bearer-Token, siehe Authentifizierung.
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'Im Antwort wird eine Sitzungs-ID im UUID-Format zurückgegeben. Alle folgenden Schritte beziehen sich auf diese, nicht auf die Kontonummer: das Konto existiert noch nicht.
Eine Alternative zum Einloggen über den QR-Code anstelle des Codes aus der Nachricht ist POST /v2/accounts/auth-sessions/qr.
Überprüfen Sie den Status der Sitzung, bis sie in den Wartemodus für den Code wechselt:
curl https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID \
-H "Authorization: Bearer YOUR_API_TOKEN"Wenn der Code nicht angekommen ist, fordern Sie eine erneute Zusendung an: POST /v2/accounts/auth-sessions/{auth_id}/resend-code.
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID/code \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'Überprüfen Sie danach erneut den Status der Sitzung: sie wird entweder erfolgreich abgeschlossen oder fordert das Cloud-Passwort an.
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID/password \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'Dieser Schritt ist nur für Konten mit Zwei-Faktor-Authentifizierung erforderlich. Ohne diese wird die Sitzung sofort nach dem Code beendet.
curl https://api.nexifyneo.com/v2/accounts \
-H "Authorization: Bearer YOUR_API_TOKEN"Das neue Konto ist in der Liste mit seiner UUID vorhanden. Diese UUID wird dann für Dialoge und zur Verknüpfung mit der Kampagne verwendet.
Wenn etwas schiefgeht#
- Eine unvollendete Sitzung kann abgebrochen werden:
DELETE /v2/accounts/auth-sessions/{auth_id}. - Die Antwort
401bedeutet ein Problem mit dem Token und nicht mit dem Konto — siehe Authentifizierung. - Ein Abbruch bei der Überprüfung des TLS-Zertifikats steht weder im Zusammenhang mit dem Token noch mit der Sitzung:
api.nexifyneo.comgibt ein selbstsigniertes Zertifikat zurück, siehe Bekannte Einschränkungen.
Welche Konten anschließen#
Für ausgehende Verbindungen separate Konten anschließen, nicht persönliche. Die Entscheidung über die Sperrung trifft die Plattform, und beim Verlust eines Kontos bleiben die Korrespondenz und Kontakte im NN Agent — Sie setzen mit einem anderen fort. Weitere Informationen in den häufig gestellten Fragen.
Weiter#
- Erste Kampagne über API starten — was mit dem verbundenen Konto zu tun ist.
- Konten in der API — vollständige Liste der Operationen.