---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Interaktionsmanagement-API

# Interaktionsmanagement-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer

Die Interaktionsmanagement API stellt Endpunkte zum Erstellen von Interaktionen bereit.
Diese Klasse erfordert das Plugin „Interaktionsprotokollierung, Weiterleitung und Warteschlange" (com.glide.interaction).

## Interaktion -- POST /now/Interaction {#ariaid-title2}

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

### URL-Format {#interaction-POST__section_msq_nfz_cmb}

Versionierte URL: /api/now/{api_Version}/Interaction

Standard-URL: /api/now/Interaction  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#interaction-POST__entry__2}{#interaction-POST__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#interaction-POST__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#interaction-POST__entry__10}

| Element | Beschreibung |
|-|-|
| Kanal | Erforderlich. SYS_ID für den Interaktions-Connector, für den Sie eine Interaktion erstellen möchten. Datentyp: Zeichenfolge |
| context | Eine Zuordnung oder ein Tabelle/sys_ID-Paar. Standardmäßig haben Interaktionen einen Datensatz in der Tabelle „Interaction_JSON_Blob", der Kontextdaten als JSON-Objekt speichert. Sie können eine Interaktion für Kontext auf einen anderen Datensatz 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 ist Interaction_JSON_Blob. Wenn Sie die Kontexttabelle definieren, müssen Sie auch die Kontext-ID definieren. Datentyp: Zeichenfolge |
| Channel_metadata | Zuordnung oder ein Tabelle/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 Kanalmetadaten-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 Kanalmetadetabelle definieren, müssen Sie auch die Kanalmetadaten-ID definieren. Datentyp: Zeichenfolge |
| Warteschlange | SYS_ID für die Warteschlange, die Sie der Interaktion zuordnen möchten. Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#interaction-POST__entry__28}{#interaction-POST__accept-RESTAPI}{#interaction-POST__content_type-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen.]

{#interaction-POST__entry__34}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### 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 [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#interaction-POST__entry__38}{#interaction-POST__entry-401-status-code}{#interaction-POST__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 201 | Gibt an, dass die Abfrage erfolgreich ausgeführt wurde. |
| 400 | Gibt an, dass mindestens ein obligatorischer Parameter in der Anforderung fehlt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#interaction-POST__table_bsj_y3z_cmb__entry__2}

| Element | Beschreibung |
|-|-|
| assigned_to | Die sys_ID des Anwenders, dem die Interaktion zugewiesen ist. Datentyp: Zeichenfolge |
| ChannelMetadataDocument | Die sys_ID des Kanalmetadatendokuments, das der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| ChannelMetadataTable | Der Tabellenname der Kanalmetadentabelle, die der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| Channel_metadata | Alle Kanalmetadaten, die für die Interaktion enthalten sind. Datentyp: Zeichenfolge |
| Closed_by | Die sys_ID des Anwenders, der die Interaktion geschlossen hat. Datentyp: Zeichenfolge |
| ContextDocument | Die sys_ID für das Kontextdokument, das der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| contextTable | Der Name der Tabelle, die der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| Nummer | Die Nummer der neuen Interaktion. Datentyp: Zeichenfolge |
| Geöffnet_für | Die sys_ID des Anwenders, für den die Interaktion geöffnet wurde. Datentyp: Zeichenfolge |
| Warteschlange | Die sys_ID für die Warteschlange, für die Sie die Interaktion erstellen. Datentyp: Zeichenfolge |
| Staat | Der Status, in dem sich die Interaktion befindet. Wenn Sie eine Warteschlange zuweisen, ändert sich der Status automatisch in In Warteschlange , Andernfalls ist der Standardwert Neu . Datentyp: Zeichenfolge |
| sys_id | Die sys_ID der Interaktion. Datentyp: Zeichenfolge |
[ ]

{#interaction-POST__table_bsj_y3z_cmb}  

### Beispiel für 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 {#ariaid-title3}

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

### URL-Format {#interaction-POST-close__section_qhp_23z_cmb}

Versionierte URL: /api/now/{api_Version}Interaktion/{Interaction_ID}/CLOSE

Standard-URL: /api/now/Interaction/{Interaction_ID}/close  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#interaction-POST-close__entry__2}{#interaction-POST-close__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. 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 : 7. Pfad-Parameter]

{#interaction-POST-close__entry__8}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 8. Abfrageparameter]

{#interaction-POST-close__entry__12}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#interaction-POST-close__entry__16}{#interaction-POST-close__accept-RESTAPI}{#interaction-POST-close__content_type-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 10. Anforderungskopfzeilen.]

{#interaction-POST-close__entry__22}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwort-Header]

### 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 [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#interaction-POST-close__entry__26}{#interaction-POST-close__entry-200-status-code}{#interaction-POST-close__entry-401-status-code}{#interaction-POST-close__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 12. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#interaction-POST-close__table_ykz_y3z_cmb__entry__2}

| Element | Beschreibung |
|-|-|
| assigned_to | Die sys_ID des Anwenders, dem die Interaktion zugewiesen ist. Datentyp: Zeichenfolge |
| ChannelMetadataDocument | Die sys_ID des Kanalmetadatendokuments, das der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| ChannelMetadataTable | Der Tabellenname der Kanalmetadentabelle, die der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| Channel_metadata | Alle Kanalmetadaten, die für die Interaktion enthalten sind. Datentyp: Zeichenfolge |
| Closed_by | Die sys_ID des Anwenders, der die Interaktion geschlossen hat. Datentyp: Zeichenfolge |
| ContextDocument | Die sys_ID für das Kontextdokument, das der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| contextTable | Der Name der Tabelle, die der Interaktion zugeordnet ist. Datentyp: Zeichenfolge |
| Nummer | Die Nummer der neuen Interaktion. Datentyp: Zeichenfolge |
| Geöffnet_für | Die sys_ID des Anwenders, für den die Interaktion geöffnet wurde. Datentyp: Zeichenfolge |
| Warteschlange | Die sys_ID für die Warteschlange, für die Sie die Interaktion erstellen. Datentyp: Zeichenfolge |
| Staat | Der Status, in dem sich die Interaktion befindet. Wenn Sie eine Warteschlange zuweisen, ändert sich der Status automatisch in In Warteschlange , Andernfalls ist der Standardwert Neu . Datentyp: Zeichenfolge |
| sys_id | Die sys_ID der Interaktion. Datentyp: Zeichenfolge |
[ ]

{#interaction-POST-close__table_ykz_y3z_cmb}  

### Beispiel für 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"
      }
    }


