Webhook-Prüfdienst

Ermöglicht Entwickler:innen die Prüfung der Verfügbarkeit des GPTBots-Webhook-Dienstes sowie die Prüfung der Verfügbarkeit der für den Ziel-Agent konfigurierten Webhook-URL.

Verfügbarkeit der für den Agent konfigurierten Webhook-Dienste prüfen

GPTBots ermöglicht Entwickler:innen, die Verfügbarkeit aller für den Ziel-Agent konfigurierten Webhook-URLs per API zu prüfen, einschließlich der für „Nachricht senden" und „Menschlicher Service – Webhook" konfigurierten Webhook-URLs. Beim Aufruf dieser Schnittstelle prüft GPTBots automatisch alle für den zum aktuellen API Key gehörenden Agent konfigurierten Webhook-URLs, ohne dass ein zusätzliches Prüfziel angegeben werden muss, und gibt das Prüfergebnis für jeden Webhook einzeln in der Antwort zurück.
Die vom Feld istest betroffenen Webhook-Dienste von Entwickler:innen sind die folgenden:

• Der Anfragekörper, mit dem die Nachricht-senden-API Antwortnachrichten an den Webhook sendet, enthält dieses Feld, Details anzeigen
• Der Anfragekörper für den Empfang von Benachrichtigungen über Dialoganfragen des menschlichen Service und von Nutzernachrichten enthält dieses Feld, Details anzeigen

Der Webhook-Dienst von Entwickler:innen sollte beim Empfang einer Anfrage das Feld istest im Nachrichtenkörper auswerten: Bei istest=true handelt es sich um eine Verfügbarkeitsprüfanfrage, die nicht als echte Geschäftsnachricht verarbeitet werden sollte (also nicht speichern, keinen menschlichen Service auslösen usw.); die Rückgabe des HTTP-Statuscodes 200 bedeutet, dass dieser Webhook verfügbar ist.

Anfragemethode

POST

Anfrage-URL

https://api-${endpoint}.gptbots.ai/v1/webhook/check

Authentifizierung

Siehe API-Übersicht für die Erläuterungen zur Authentifizierung. Diese Schnittstelle identifiziert den Ziel-Agent über den API Key und prüft die unter diesem Agent konfigurierten Webhooks.

Anfrage

Beispielanfrage

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/webhook/check' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json'

                    

Anfrage-Header

Anfrageparameter

Diese Schnittstelle erfordert keine Übergabe von Anfrageparametern; GPTBots prüft automatisch alle für den zum aktuellen API Key gehörenden Agent konfigurierten Webhook-URLs.

Antwort

Beispielantwort

                      
                      {
  "results": [
    {
      "type": "message",
      "component_id": null,
      "component_name": null,
      "webhook_url": "https://your_domain/webhook/message",
      "reachable": true,
      "http_status": 200,
      "latency_ms": 156
    },
    {
      "type": "human_service",
      "component_id": "665d88b03ce2b13cf2d57346",
      "component_name": "人工服务-售前",
      "webhook_url": "https://your_domain/presale/human/service/conversation/establish",
      "reachable": true,
      "http_status": 200,
      "latency_ms": 188
    },
    {
      "type": "human_service",
      "component_id": "665d88b03ce2b13cf2d57347",
      "component_name": "人工服务-售后",
      "webhook_url": "https://your_domain/aftersale/human/service/conversation/establish",
      "reachable": false,
      "http_status": 502,
      "latency_ms": 3000
    }
  ]
}

                    

Erfolgsantwort

Empfehlung zur Verfügbarkeitsbeurteilung

GPTBots sendet die Prüfanfrage mit istest=true im Standard-Nachrichtenformat an die Webhook-URL und beurteilt die Verfügbarkeit anhand des Rückgabeergebnisses:

Fehlerantwort

Fehlercodes

Statusprüfung des GPTBots-Webhook-Dienstes

GPTBots stellt eine Health-Monitoring-Schnittstelle zur Prüfung des Webhook-Dienstes bereit; Entwickler:innen können diese Schnittstelle aufrufen, um zu ermitteln, ob der GPTBots-Webhook-Dienst normal verfügbar ist. Gibt die Schnittstelle den HTTP-Statuscode 200 zurück und enthält der Antwortkörper die englische Kennzeichnung für einen normalen Dienst (z. B. service is normal), bedeutet dies, dass der GPTBots-Webhook-Dienst normal verfügbar ist. Diese Schnittstelle erfordert keine Authentifizierung und gibt Klartext zurück.

Anfragemethode

GET

Anfrage-URL

https://api.gptbots.ai/v1/webhook/service/health

Beispielanfrage

                      
                      curl -X GET 'https://api.gptbots.ai/v1/webhook/service/health'

                    

Antwort

Ist der GPTBots-Dienst normal verfügbar, wird der HTTP-Statuscode 200 zurückgegeben und der Antwortkörper enthält die englische Kennzeichnung für einen normalen Dienst.

                      
                      service is normal

                    

Empfehlung zur Verfügbarkeitsbeurteilung

Der Aufrufer muss lediglich den HTTP-Statuscode als Kriterium heranziehen:

Es wird empfohlen, ein angemessenes Anfrage-Timeout (z. B. 3–5 Sekunden) festzulegen und mit fester Frequenz abzufragen (QPM:3); diese Schnittstelle ist authentifizierungsfrei, beim Aufruf muss kein API Key mitgeführt werden.