Ticket API

Unusual Suite stellt eine HTTP-REST-API bereit, die Support-Anfragen entgegennimmt und KI-generierte Antworten im JSON-Format zurückgibt.

API-Zugang einrichten

1. Konfigurieren Sie einen Unusual Suite-Benutzer, der Schreibzugriff auf Ticket-Datensätze hat.
2. Weisen Sie diesem Benutzer in der Benutzeroberfläche einen API-Schlüssel zu.
3. Kopieren Sie den API-Schlüssel in die Zwischenablage.

Eine Anfrage senden

1. Senden Sie eine HTTP-POST-Anfrage an https://ds-01.unusual-suite.com/open-api/ticket/compose-response.
2. Fügen Sie einen Anfrage-Header mit dem Schlüssel api-key hinzu, der auf den API-Schlüssel aus dem obigen Einrichtungsschritt gesetzt ist.
3. Setzen Sie den Anfragekörper auf eines der folgenden:
   • Die Ticket-Anfrage als Klartext, Markdown oder HTML.
   • Ein JSON-Objekt (siehe Struktur unten), wenn Sie Anhänge einfügen möchten.
4. Warten Sie auf die Antwort – Unusual Suite antwortet in der Regel innerhalb von Sekunden, aber es kann bis zu einer Minute dauern.

Anfragekörper-Format (mit Anhängen)

Beim Senden von Anhängen verwenden Sie diese JSON-Struktur:

{
  "text": "<der Ticket-Text als Klartext, Markdown-Text oder HTML>",
  "attachments": [       // Anhänge sind optional
    {                   // Ein oder mehrere Anhang-Objekte können angegeben werden
      "name": "<der Anhangsname; die Dateiendung ist wichtig und muss angegeben werden>",
      "content": "<der Anhangsinhalt als Klartext oder als base64-kodierter Binär-String>"
    }
  ]
}

Antwortformat

Unusual Suite gibt ein JSON-Objekt zurück. Einige Eigenschaften werden in diesem Beispiel weggelassen, da sie für die meisten Integrationen nicht relevant sind:

{
  "text": "<Antwort im Markdown-Format>",
  "text-html": "<Antwort im HTML-Format>"
}