logoDokumentation
Suchen

Ticket erstellen

Entwickler:innen können Support-Tickets über die API erstellen. Nach erfolgreicher Ticket-Erstellung wird die Ticket-ID zurückgegeben. Diese Funktion ermöglicht eine effiziente und automatisierte IT-Support Ticket-Erstellung und ist ideal für Unternehmen, die ihre Support-Prozesse optimieren möchten.

Anfragemethode

POST

Anfrage-URL

https://livedesk-api.engagelab.com/api/v2/accounts/tickets

Authentifizierung

Details zur Authentifizierung finden Sie in der Beschreibung unter API-Übersicht.

Anfrage

Beispielanfrage

curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "title": "Papierstau im Drucker, Drucken nicht möglich", "description": "Kund:in meldet A4-Papierstau im Ausgabefach, dringende Bearbeitung erforderlich.", "attachments": [ { "file_url": "https://example.com/files/error.jpg" } ], "requester": { "euid": "contact_12345", "channel_contacts": { "channel_id": "inbox_100", "contact_id": "-1001234567890", "sub_contact_id": "23232323", "followers": [ { "id": "7562646527", "name": "Zhang San" } ] } }, "submitter": { "id": "u_12345" }, "assignment_team": "IT Support", "priority": "high", "ticket_type": "incident", "custom_fields": { "device_sn": "PRN-2024-001", "location": "Beijing HQ - 3. Etage Druckerraum" } }'
              
              curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
  "title": "Papierstau im Drucker, Drucken nicht möglich",
  "description": "Kund:in meldet A4-Papierstau im Ausgabefach, dringende Bearbeitung erforderlich.",
  "attachments": [
    {
      "file_url": "https://example.com/files/error.jpg"
    }
  ],
  "requester": {
    "euid": "contact_12345",
    "channel_contacts": {
      "channel_id": "inbox_100",
      "contact_id": "-1001234567890",
      "sub_contact_id": "23232323",
      "followers": [
        {
          "id": "7562646527",
          "name": "Zhang San"
        }
      ]
    }
  },
  "submitter": {
    "id": "u_12345"
  },
  "assignment_team": "IT Support",
  "priority": "high",
  "ticket_type": "incident",
  "custom_fields": {
    "device_sn": "PRN-2024-001",
    "location": "Beijing HQ - 3. Etage Druckerraum"
  }
}'

            
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Feld Typ Beschreibung
Authorization string Verwenden Sie Authorization: Basic base64(API Key:API Secret) zur Authentifizierung. Den API Key und das API Secret erhalten Sie auf der API-Key-Seite. Verbinden Sie beide mit einem Doppelpunkt und kodieren Sie das Ergebnis anschließend in Base64.
Content-Type application/json Datentyp, Wert ist application/json.

Body-Parameter

Feld Typ Erforderlich Beschreibung
title String Ja Ticket-Titel.
description String Nein Ticket-Beschreibung, unterstützt md-Format.
attachments Array Nein Array von Anhängen, vorheriger Upload über /upload erforderlich.
file_url String Ja Dateiadresse.
requester Object Ja Informationen zum:zur Anfragenden.
euid String Nein Eindeutige Kontakt-ID.
channel_contacts Object Nein Kanal-Kontakt-Zuordnung (mindestens eine euid erforderlich).
channel_id String Ja Kanal-ID.
contact_id String Ja Kanal-Kontakt-ID (z. B. TG chat_id).
sub_contact_id String Nein Kanal-Sub-Kontakt-ID (z. B. TG topic_id / E-Mail-Thread-ID).
followers Array Nein Follower:innen-IDs für Push-/Benachrichtigungen im Kanal, inkl. id- und name-Feld.
  • id: Follower:in-ID.
  • name: Name der Follower:in.
  • submitter Object Nein ID des:der Einreichenden (interne Mitgliederkonto-ID), enthält das Feld id.
  • id: Einreichende:r-ID.
  • assignment_team String Nein Name des zugewiesenen Teams (muss existieren).
    priority String Nein Priorität: high/medium/low, Standardwert ist medium, falls nicht angegeben.
    ticket_type String Nein Tickettyp: problem/incident/question/task/None, Standardwert ist None, falls nicht angegeben.
    custom_fields Object Nein Benutzerdefinierte Felder (z. B. Quellinformationen), im Key-Value-Format.

    Antwortbeispiel

    Erfolgreiche Antwort

    { "code": 0, "message": "Erfolg", "data": { "ticket_id": "tk_20251104_789abc", "message": "Ticket erfolgreich erstellt" } }
                  
                  {
      "code": 0,
      "message": "Erfolg",
      "data": {
        "ticket_id": "tk_20251104_789abc",
        "message": "Ticket erfolgreich erstellt"
      }
    }
    
                
    Diesen Codeblock im schwebenden Fenster anzeigen

    Antwort-Parameter

    Feld Typ Erforderlich Beschreibung
    ticket_id String Nein Ticket-ID.
    message String Nein Rückgabemeldung, z. B.: „Ticket erfolgreich erstellt“
    icon
    Vertrieb kontaktieren