Manueller Support

Wenn Entwickler:innen Webhook als Zugriffsmethode für den manuellen Support wählen, müssen sie zunächst einen Webhook-Service in ihrer Serverumgebung einrichten. Entwickler:innen müssen gemäß den Vorgaben die folgenden drei Schnittstellen bereitstellen, um Anfragen für den manuellen Support, Nutzernachrichten und Antworten des manuellen Kundendienstes zu empfangen. GPTBots stellt zudem zwei Schnittstellen zur Verfügung, um Antworten des Kundendienstes und Anweisungen zum Schließen von Konversationen zu empfangen.

Wichtige Hinweise:

1. Entwickler:innen müssen sicherstellen, dass ihr Webhook-Service ordnungsgemäß funktioniert, da dies den Betrieb des menschlichen Supports direkt beeinflusst.
   • Wird nach dem Start des menschlichen Supports als „Beschäftigt“ angezeigt, bedeutet dies, dass der Webhook-Service der Entwickler:innen nicht funktioniert.
   • Wird nach dem Start des menschlichen Supports als „Verbinden“ angezeigt, funktioniert der Webhook-Service der Entwickler:innen ordnungsgemäß.
2. Nach erfolgreicher Initiierung einer Anfrage für den menschlichen Support:
   • Entwickler:innen müssen die Schnittstelle Antwort auf Benutzernachricht (https://api.gptbots.ai/v1/human/message/receive) aufrufen, um dem:der Nutzer:in mindestens eine Nachricht zu senden und so die Gesprächsverbindung herzustellen.
   • Erfolgt innerhalb der konfigurierten Wartezeit (Standard: 60 Sekunden) keine Antwort auf die Benutzernachricht, wird die menschliche Support-Konversation automatisch beendet.

Benachrichtigung über Anfrage für menschlichen Support empfangen

Wenn ein:e Endnutzer:in eine Anfrage für den menschlichen Support stellt, leitet GPTBots diese Anfrage an den Webhook-Service der Entwickler:innen weiter. Ein Response-Statuscode 200 des Interface-Services der Entwickler:innen signalisiert die erfolgreiche Erstellung der menschlichen Support-Konversation.

Anfrage-Methode

POST

Endpoint

https://your_domain/conversation/establish

Beispielanfrage

                      
                      curl -X POST 'https://YOUR_DOMAIN/human/service/conversation/establish' \
-H 'Content-Type: application/json' \
-d '{
  "body": [
    {
      "text": "human service",
      "message_type": "QUESTION"
    },
    {
      "text": "",
      "message_type": "ANSWER"
    }
  ],
  "timestamp": 1742265090895,
  "email": "bob@gmail.com",
  "conversation_id": "67d8db020fa31d1ef64f53dg",
  "bot_id": "665d88b03ce2b13cf2d573454",
  "user_info": {
    "phone": null,
    "email": "bob@gmail.com",
    "user_id": "KDslas",
    "anonymous_id": "652face5184b30540a6ea7fe"
  }
}'

                    

Hinweis: Die conversation_id in diesem Request-Body dient ausschließlich zur eindeutigen Identifikation von Konversationen im manuellen Support und unterscheidet sich von der eindeutigen ID, die für Agentenkonversationen durch Konversations-ID erstellen generiert wird.

Anfrageparameter

Hinweise zum Feld email:

• Bei der Initiierung des manuellen Supports über iframe/Share/Bubble Widget muss der:die Nutzer:in seine:ihre E-Mail-Adresse angeben. Entwickler:innen können die Nutzer:innen-E-Mail-Adresse auch anpassen, um die Eingabe zu umgehen.
• Bei Anfragen über Drittanbieter-Plattformen wie WhatsApp/Telegram/Livechat wird standardmäßig support@gptbots.ai als E-Mail-Adresse verwendet. Für Livechat können Entwickler:innen die Nutzer:innen-E-Mail-Adresse anpassen.
• Bei Anfragen über die API kann das Feld email leer sein. Ist es leer, wird standardmäßig support@gptbots.ai verwendet.

Antwort

Chat-Schnittstelle

Mit der erstellten conversation_id kann die Nachricht des:der Nutzer:in an den manuellen Kundendienst gesendet werden.

Anfrage-Methode

POST

Endpoint

https://your_domain/chat

Anfrageparameter

Antwort

Schnittstelle zum Schließen der Konversation

Wenn eine Nutzer:innen-Konversation abläuft oder der:die Agent-Nutzer:in die Konversation aktiv beendet, wird diese Schnittstelle aufgerufen, um die Konversation zu schließen.

Anfrage-Methode

POST

Endpoint

https://your_domain/conversation/close

Anfrage-Header

Anfrageparameter

Antwort

Antwort auf Benutzernachrichten

Wenn Entwickler:innen Webhook als Integrationsmethode für den menschlichen Support wählen, stellt GPTBots eine Schnittstelle zur Verfügung, um auf Benutzernachrichten zu antworten. Über diese Schnittstelle können menschliche Kundendienstmitarbeiter:innen Nachrichteninhalte an Nutzer:innen zurücksenden.

Anfrage-Methode

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/human/message/receive

Anfrage-Header

Anfrageparameter

Antwort

Manueller Support schließt Konversation

Wenn Entwickler:innen Webhook als Zugriffsmethode für den manuellen Support wählen, kann der von GPTBots bereitgestellte manuelle Kundendienst die Konversation bei Bedarf aktiv schließen. Nach dem Schließen erhält der:die Nutzer:in keine weiteren Nachrichten vom Kundendienst, es sei denn, er:sie startet erneut eine manuelle Support-Konversation.

Anfrage-Methode

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/human/close

Anfrage-Header

Anfrageparameter

Antwort