Interaction Management API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 5 Minuten Lesedauer

    • Die Interaction Management- API stellt Endpunkte zum Erstellen von Interaktionen bereit.

    Diese Klasse erfordert das Interaction Logging-, Routing- und Queueing-Plugin (com.glide.interaction).

    Interaktion: POST /now/interaction

    Fügt einen Datensatz in die Interaktionstabelle ein oder aktualisiert ihn.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/interaction

    Standard-URL: /api/now/interaction

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Element Beschreibung
    channel Erforderlich. Sys_id für den Interaktions-Connector, für den Sie eine Interaktion erstellen möchten.

    Datentyp: Zeichenfolge
    context Eine Map oder ein Paar aus Tabelle und sys_id. Standardmäßig verfügen Interaktionen über einen Datensatz in der interactive_json_blob-Tabelle, in dem Kontextdaten als JSON-Objekt gespeichert werden. Sie können eine Interaktion auf einen anderen Datensatz für den Kontext verweisen. Verwenden Sie context oder context_table/context_id, um den Kontext für eine Interaktion zu definieren.

    Datentyp: Zeichenfolge
    context_id Dokument-ID für einen Datensatz, den Sie zum Speichern des Kontexts verwenden möchten. Der Standardwert ist ein neuer Datensatz in der Tabelle insteraction_json_blob. Wenn Sie die Kontext-ID definieren, müssen Sie auch die Tabelle definieren.

    Datentyp: Zeichenfolge
    context_table Kontexttabelle, für die Sie den Interaktionskontext speichern möchten. Der Standardwert istaction_json_blob. Wenn Sie die Kontexttabelle definieren, müssen Sie auch die Kontext-ID definieren.

    Datentyp: Zeichenfolge
    channel_metadata Zuordnung oder ein table/sys_id-Paar. Kanalmetadaten enthalten Informationen, die ein Connector zur Kommunikation über den zugehörigen Kanal verwenden kann.

    Datentyp: Zeichenfolge
    channel_metadata_id Dokument-ID für einen Datensatz, den Sie zum Speichern von Kanalmetadaten verwenden möchten. Der Standardwert ist ein neuer Datensatz in der Tabelle live_group_profile. Wenn Sie die Kanal-Metadaten-ID definieren, müssen Sie auch die Tabelle definieren.

    Datentyp: Zeichenfolge
    channel_metadata_table Tabelle, die Sie zum Speichern von Kanalmetadaten verwenden möchten. Der Standardwert ist die Tabelle live_group_profile. Wenn Sie die Kanalmetadatentabelle definieren, müssen Sie auch die Kanalmetadaten-ID definieren.

    Datentyp: Zeichenfolge
    Warteschlange Sys_id für die Warteschlange, die der Interaktion zugeordnet werden soll.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    201 Gibt an, dass die Abfrage erfolgreich ausgeführt wurde.
    400 Gibt an, dass ein oder mehrere obligatorische Parameter in der Anforderung fehlten.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Element Beschreibung
    assigned_to Die sys_id des Benutzers, dem die Interaktion zugewiesen ist.

    Datentyp: Zeichenfolge
    Kanalmetadatendokument Die sys_id des Kanalmetadatendokuments, das der Interaktion zugeordnet ist.

    Datentyp: Zeichenfolge
    Kanalmetadatentabelle Der Tabellenname der Kanalmetadatentabelle, die der Interaktion zugeordnet ist.

    Datentyp: Zeichenfolge
    channel_metadata Alle für die Interaktion enthaltenen Kanalmetadaten.

    Datentyp: Zeichenfolge
    closed_by Die sys_id des Benutzers, der die Interaktion geschlossen hat.

    Datentyp: Zeichenfolge
    Kontextdokument Die sys_id für das mit der Interaktion verknüpfte Kontextdokument.

    Datentyp: Zeichenfolge
    contextTable Der Name der Tabelle, die der Interaktion zugeordnet ist.

    Datentyp: Zeichenfolge
    Nummer Die Nummer der neuen Interaktion.

    Datentyp: Zeichenfolge
    opened_for Die sys_id des Benutzers, für den die Interaktion geöffnet war.

    Datentyp: Zeichenfolge
    Warteschlange Die sys_id für die Warteschlange, für die Sie die Interaktion erstellen.

    Datentyp: Zeichenfolge
    Staat Der Zustand, in dem sich die Interaktion befindet. Wenn Sie eine Warteschlange zuweisen, ändert sich der Status automatisch in In der Warteschlange, ansonsten ist der Standardwert Neu.

    Datentyp: Zeichenfolge
    sys_id Die sys_id der Interaktion.

    Datentyp: Zeichenfolge

    Beispiel für eine cURL-Anforderung

    curl "http://instance.servicenow.com/api/now/interaction" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"channel\":\"28a59893873103002ae97e2526cb0b5d\",\"queue\":\"f3a50867b30303002186a72256a8dcb7\"}" \
--user "username":"password"
    {
  "result": {
    "channel": "28a59893873103002ae97e2526cb0b5d",
    "context": {
      "present": true
    },
    "queue": "f3a50867b30303002186a72256a8dcb7",
    "state": "queued",
    "number": "IMS0000075",
    "contextDocument": "1863a6f0d9471300964f387107a8a36d",
    "contextTable": "interaction_json_blob",
    "channelMetadataDocument": "9463a6f0d9471300964f387107a8a36c",
    "channelMetadataTable": "live_group_profile",
    "channel_metadata": {
      "present": true
    },
    "sys_id": "dc63a6f0d9471300964f387107a8a36b",
    "assigned_to": "",
    "closed_by": "",
    "opened_for": ""
  }
}

    Interaktion: POST /now/interaction/{interaction_id}/close

    Ändert den Status einer Interaktion in „Geschlossen“ oder „Abgeschlossen“.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}interaction/{interaction_id}/close

    Standard-URL: /api/now/interaction/{interaction_id}/close

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    interaction_id Sys_id für die Interaktion, die Sie schließen möchten.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Element Beschreibung
    assigned_to Die sys_id des Benutzers, dem die Interaktion zugewiesen ist.

    Datentyp: Zeichenfolge
    Kanalmetadatendokument Die sys_id des Kanalmetadatendokuments, das der Interaktion zugeordnet ist.

    Datentyp: Zeichenfolge
    Kanalmetadatentabelle Der Tabellenname der Kanalmetadatentabelle, die der Interaktion zugeordnet ist.

    Datentyp: Zeichenfolge
    channel_metadata Alle für die Interaktion enthaltenen Kanalmetadaten.

    Datentyp: Zeichenfolge
    closed_by Die sys_id des Benutzers, der die Interaktion geschlossen hat.

    Datentyp: Zeichenfolge
    Kontextdokument Die sys_id für das mit der Interaktion verknüpfte Kontextdokument.

    Datentyp: Zeichenfolge
    contextTable Der Name der Tabelle, die der Interaktion zugeordnet ist.

    Datentyp: Zeichenfolge
    Nummer Die Nummer der neuen Interaktion.

    Datentyp: Zeichenfolge
    opened_for Die sys_id des Benutzers, für den die Interaktion geöffnet war.

    Datentyp: Zeichenfolge
    Warteschlange Die sys_id für die Warteschlange, für die Sie die Interaktion erstellen.

    Datentyp: Zeichenfolge
    Staat Der Zustand, in dem sich die Interaktion befindet. Wenn Sie eine Warteschlange zuweisen, ändert sich der Status automatisch in In der Warteschlange, ansonsten ist der Standardwert Neu.

    Datentyp: Zeichenfolge
    sys_id Die sys_id der Interaktion.

    Datentyp: Zeichenfolge

    Beispiel für eine cURL-Anforderung

    curl "http://instance.servicenow.com/api/now/interaction/b243cde4208f1700964f959e0488dee8/close" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password"

    {
  "result": {
    "channel": "28a59893873103002ae97e2526cb0b5d",
    "context": {
      "present": true
    },
    "queue": "f3a50867b30303002186a72256a8dcb7",
    "state": "closed_complete",
    "number": "IMS0000060",
    "contextDocument": "3a43cde4208f1700964f959e0488dee7",
    "contextTable": "interaction_json_blob",
    "channelMetadataDocument": "fa43cde4208f1700964f959e0488dee8",
    "channelMetadataTable": "live_group_profile",
    "channel_metadata": {
      "present": true
    },
    "sys_id": "b243cde4208f1700964f959e0488dee8",
    "assigned_to": "",
    "closed_by": "6816f79cc0a8016401c5a33be04be441",
    "opened_for": "46d44a23a9fe19810012d100cca80666"
  }
}