Alle Seiten
Bereitgestellt von GitBook
1 von 5

Loading...

Loading...

Loading...

Loading...

Loading...

Kommunikationsmodul

Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "CommunicationRead", "CommunicationEdit" und "CommunicationCatalog".

Bei dem Kommunikationsmodul handelt es sich um ein kostenpflichtiges Zusatzmodul. Bitte informieren Sie sich bei Ihrem Kunden, ob dieses Modul gebucht wurde. Aufgrund von Erweiterungsarbeiten am Kommunikationsmodul kann es derzeit zu Inkonsistenzen in der Datenstrukur kommen. Eine vollständige Stabilität kann aktuell nicht garantiert werden.

Um auf die Endpunkte des Kommunikationsmoduls zugreifen zu können, benötigen Sie die Endpunktberechtigungen "Ticket lesen" und "Ticket ändern".

Einleitung

Das Kommunikationsmodul ist eine neue Applikation in WOWIPORT. Dieses Modul ist vorrangig darauf ausgerichtet, die Kommunikation von Partneranwendungen mit den Anwendern von WOWIPORT zu gewährleisten.

Bei der Verwendung von schreibenden Endpunkten kommt es unweigerlich zu Situationen, in denen ein Teil des Prozesses in der Partneranwendung abgebildet wird, während Folgeprozesse in WOWIPORT vollzogen werden müssen. Das Kommunikationsmodul soll diese Lücke schließen.

Sie können das Modul nutzen, um den Sachbearbeitern in WOWIPORT Nachrichten zu senden und erstellte Objekte beizufügen.

Einrichtung

Das Kommunikationsmodul ist an Quellen gebunden. Die Absenderquelle definiert, wer auf ein Ticket oder eine Nachricht Zugriff hat. Hierdurch ist gewährleistet, dass unbefugte Dritte keinen Zugriff auf die Kommunikation zwischen Ihrer Anwendung und WOWIPORT erhalten.

Um eine neue Nachrichtenquelle anzulegen, muss der Kunde in seiner Gruppenverwaltung die Kataloge öffnen.

Als Modul wird die Kommunikationszentrale gewählt.

Der Katalog "FIO-CC-Nachrichtenquelle" kann über das "Editieren"-Symbol bearbeitet werden.

Im folgenden Dialog kann durch Klick auf den Button "Neu" ein neuer Eintrag erstellt werden.

Für jede Nachrichtenquelle müssen zudem die möglichen Status der Nachricht definiert werden.

Hierfür legen Sie einen neuen Nachrichtenstatus im Katalog "FIO-CC-Nachrichtenstatus" an.

Bitte selektieren Sie hier die gerade angelegte Nachrichtenquelle, vergeben Sie einen Namen und wählen Sie eines der Auswahlfelder aus um die Bedeutung des Nachrichtenstatus festzulegen.

Die Nachrichtenquelle muss dann einem Nutzer und einem API-Key zugewiesen werden. In der API-Key-Konfiguration können beide Einstellungen vorgenommen werden.

Katalog in der Gruppenverwaltung
Nutzer und Nachrichtenquelle verknüpfen

Beispiel Workflow

Hier finden Sie Beispiele, wie die API in der Praxis angewendet werden kann.

In diesem Beispiel findet ein Startereignis in einer Partneranwendung auf Ebene der Nutzungseinheit statt. Die Anwendung erzeugt eine Nachricht und der Sachbearbeiter antwortet innerhalb der Nachricht. Die Partneranwendung ergänzt dann eine weitere Antwort.

Ticket lesen

Mit diesen Endpunkten können Sie Tickets lesen.

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Ticket lesen

Hinweise zur Funktion

Bei der Kommunikation über die API wird die "UserId" üblicherweise immer vorhanden sein, da nur registrierte WOWIPORT Benutzer die Schnittstellen bzw. die Benutzeroberfläche verwenden können. Bei der Weiterentwicklung des Kommunikationsmodules werden jedoch auch andere Kommunikationsmittel berücksichtigt. Bei einer Kommunikation via E-Mail wird der Benutzer durch eine verknüpfte Person bzw. durch die Node "Person" im Bereich "Communication" ersetzt. Bitte beachten Sie die verschiedenen Abhängigkeiten bei unterschiedlichen Kommunikationsformen.

Version 1.2



Kataloge

Hier finden Sie die Kataloge für das Kommunikationsmodul.

Zugeordnete Entitäten

Version 1.2



Ticket Priorität

Version 1.2



Ticket Quellen

Hinweise zur Funktion

Sie können alle Ticketquellen des Kantonsystems sehen. Ob sie diese Ticketquellen in einem schreibenden Endpunkt verwenden können, hängt von der Konfiguration des API Keys ab. Sie können diese Information im Feld "AllowTicketCreationForApiKey" sehen.

Bestimmte Ticketquellen (z.B. das Anrufprotokoll) sind für die API Anlage grundsätzlich gesperrt.

Version 1.2



Ticket Status

Version 1.2



Ticket bearbeiten

Mit diesen Endpunkten können Sie Tickets bearbeiten.

Hinweise zur Funktion

Das Kommunikationsmodul sollte Anwendung finden, wenn Sie über eine API ein neues Objekt erstellen und erwartet wird, dass dieses Objekt in WOWIPORT weiterverarbeitet wird. Beispiele hierfür wären:

  • Ein vorgeschlagener Vertragsnehmer wird erstellt.

  • Eine Rechnung wird übergeben.

  • Ein Auftrag wurde erstellt.

"AssignmentEntityId" verweist auf die Entitäts-ID aus dem entsprechenden Katalog. Die ID des Objektes wird im Schlüssel "EntityId" angegeben. Daten zu den Abteilungen können in den Objektdaten abgerufen werden.

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Ticket anlegen

Version 1.2



Kommentar hinzufügen

Dieser Endpunkt wird zukünftig zugunsten der Konversationen abgekündigt. Der Endpunkt ist mit den Tickets weiterhin kompatibel, allerdings fehlen wesentliche Daten für die Konversationen.

Version 1.2



Konversationen hinzufügen

Hinweise zur Funktion

Sie können in den Konversationen andere Ticketquellen verwenden, wenn diese Ihrem API Key zugeordnet sind.

Die "Location" kann nur in der Nachrichtenquelle "Gesprächsnotiz" verwendet werden.

Version 1.2



Ticket löschen

Version 1.2



https://docs.openwowi.de/schnittstelle-v1.x/objektdaten/abteilung
post
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
Rumpf
TicketIdinteger · int32Optional
TicketSourceIdinteger · int32Optional
PersonIdinteger · int32 | nullfähigOptional
CreatedAtstring · date-timeOptional
Locationstring | nullfähigOptional
Contentstring | nullfähigOptional
Antworten
200

OK

400

Bad Request

401

Unauthorized

post
/openwowi/v1.2/CommunicationEdit/Ticket/AddConversation
{
  "Id": 1,
  "IdNum": "text"
}
POST /openwowi/v1.2/CommunicationEdit/Ticket/AddConversation HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "TicketId": 1,
  "TicketSourceId": 1,
  "PersonId": 1,
  "CreatedAt": "2025-12-15T10:51:33.510Z",
  "Location": "text",
  "Content": "text"
}
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
ticketIdinteger · int32Optional
ticketIdNumstringOptional
ticketPriorityIdinteger · int32Optional
ticketStatusIdinteger · int32Optional
ticketSourceIdinteger · int32Optional
userIdinteger · int32Optional
departmentIdinteger · int32Optional
ticketAssignmentEntityIdinteger · int32Optional
ticketAssignmentEntityValueEntityIdinteger · int32Optional
includeCommentsbooleanOptional
includeAssignmentEntitybooleanOptional
showNullValuesbooleanOptionalDefault: false
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CommunicationRead/Ticket
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
showNullValuesbooleanOptionalDefault: false
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CommunicationCatalog/TicketAssignmentEntity
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
showNullValuesbooleanOptionalDefault: false
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CommunicationCatalog/TicketPriority
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
showNullValuesbooleanOptionalDefault: false
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CommunicationCatalog/TicketSource
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
showNullValuesbooleanOptionalDefault: false
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CommunicationCatalog/TicketStatus
post
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
Rumpf
Subjectstring | nullfähigOptional
Contentstring | nullfähigOptional
SourceIdinteger · int32Optional
PriorityIdinteger · int32Optional
DepartmentIdinteger · int32 | nullfähigOptional
UserIdinteger · int32 | nullfähigOptional
ExternalReferencestring | nullfähigOptional
Antworten
201

Created

400

Bad Request

401

Unauthorized

post
/openwowi/v1.2/CommunicationEdit/Ticket
post
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
Rumpf
TicketIdinteger · int32Optional
Contentstring | nullfähigOptional
PersonIdinteger · int32 | nullfähigOptional
Antworten
200

OK

400

Bad Request

401

Unauthorized

post
/openwowi/v1.2/CommunicationEdit/Ticket/AddComment
delete
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Pfadparameter
ticketIdinteger · int32Erforderlich
Abfrageparameter
apiKeystringOptional
Antworten
200

OK

400

Bad Request

401

Unauthorized

delete
/openwowi/v1.2/CommunicationEdit/Ticket/{ticketId}
GET /openwowi/v1.2/CommunicationRead/Ticket HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "IdNum": "text",
    "TimeReceived": "2025-12-15T10:51:33.510Z",
    "Subject": "text",
    "Content": "text",
    "ExternalReference": "text",
    "Department": {
      "Id": 1,
      "Name": "text"
    },
    "UserId": 1,
    "CreatedByUserId": 1,
    "CreatedByApiUser": true,
    "ShareStatus": true,
    "Priority": {
      "Id": 1,
      "Code": "text"
    },
    "Status": {
      "Id": 1,
      "Code": "text"
    },
    "Source": {
      "Id": 1,
      "Code": "text",
      "TicketSourceClassification": {
        "Id": 1,
        "Code": "text"
      },
      "DefaultTicketPriority": {
        "Id": 1,
        "Code": "text"
      },
      "DefaultTicketStatus": {
        "Id": 1,
        "Code": "text"
      },
      "IsPersonMandatory": true,
      "IsSubjectMandatory": true,
      "IsContentMandatory": true,
      "IncomingSourceOnly": true,
      "DefaultTicketStatusDuringProcessing": {
        "Id": 1,
        "Code": "text"
      },
      "AllowTicketCreationForApiKey": true
    },
    "Comments": [
      {
        "Id": 1,
        "TicketSource": {
          "Id": 1,
          "Code": "text"
        },
        "CreatedAt": "2025-12-15T10:51:33.510Z",
        "Content": "text",
        "Location": "text",
        "Person": {
          "Id": 1,
          "IdNum": "text",
          "Name": "text"
        },
        "UserName": "text",
        "UserId": 1,
        "Read": true,
        "CommentFromApi": true
      }
    ],
    "MainAssignment": {
      "Id": 1,
      "AssignmentEntity": {
        "Id": 1,
        "Code": "text"
      },
      "EntityId": 1
    },
    "Assignment": [
      {
        "Id": 1,
        "AssignmentEntity": {
          "Id": 1,
          "Code": "text"
        },
        "EntityId": 1
      }
    ]
  }
]
GET /openwowi/v1.2/CommunicationCatalog/TicketAssignmentEntity HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "Code": "text"
  }
]
GET /openwowi/v1.2/CommunicationCatalog/TicketPriority HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "Code": "text"
  }
]
GET /openwowi/v1.2/CommunicationCatalog/TicketSource HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "Code": "text",
    "TicketSourceClassification": {
      "Id": 1,
      "Code": "text"
    },
    "DefaultTicketPriority": {
      "Id": 1,
      "Code": "text"
    },
    "DefaultTicketStatus": {
      "Id": 1,
      "Code": "text"
    },
    "IsPersonMandatory": true,
    "IsSubjectMandatory": true,
    "IsContentMandatory": true,
    "IncomingSourceOnly": true,
    "DefaultTicketStatusDuringProcessing": {
      "Id": 1,
      "Code": "text"
    },
    "AllowTicketCreationForApiKey": true
  }
]
GET /openwowi/v1.2/CommunicationCatalog/TicketStatus HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "Code": "text"
  }
]
{
  "Id": 1,
  "IdNum": "text"
}
POST /openwowi/v1.2/CommunicationEdit/Ticket HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "Subject": "text",
  "Content": "text",
  "SourceId": 1,
  "PriorityId": 1,
  "DepartmentId": 1,
  "UserId": 1,
  "ExternalReference": "text",
  "MainEntityAssignment": {
    "AssignmentEntityId": 1,
    "EntityId": 1
  },
  "EntityAssignments": [
    {
      "AssignmentEntityId": 1,
      "EntityId": 1
    }
  ]
}
POST /openwowi/v1.2/CommunicationEdit/Ticket/AddComment HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "TicketId": 1,
  "Content": "text",
  "PersonId": 1
}
DELETE /openwowi/v1.2/CommunicationEdit/Ticket/{ticketId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "Id": 1,
  "IdNum": "text"
}
{
  "Id": 1,
  "IdNum": "text"
}