WrapUp-API

Die WrapUp- API bietet Endpunkte für die Verwaltung der Wrapup-Funktionalität für externe CCaaS-Systeme (Contact Center as a Service) oder Now Platform -Arbeitsbereiche.

Diese API erfordert das Plugin „Interaktionsmanagement“ (com.glide.interaction). Um diese API aufzurufen, benötigen Sie die Rolle „interaction_integration_user“.

Wenn Service Desk-Mitarbeiter eine Interaktion schließen, können sie mithilfe der Nachbearbeitungsfunktion Abschlussdetails und Nachbearbeitungscodes zur späteren Verwendung eingeben. Weitere Informationen zur Nachbearbeitungsfunktion finden Sie unter Wrap up overview.

Um die Wrap-Up -API für die segmentierte Nachbearbeitung von Interaktionen aus externen Systemen zu verwenden, müssen Sie den geskripteten Erweiterungspunkt InteractionSegment implementieren, um Segmentdatensätze in der ausgewählten Tabelle zu erstellen und abzurufen. Wenn Sie OpenFrameverwenden, verfügt der Erweiterungspunkt über eine vorhandene Implementierung zum Erstellen und Abrufen von Segmentdatensätzen in der Telefonprotokolltabelle [sn_openframe_phone_log].

Nachbearbeitung – GET /now/wrapup/code/{code_id}

Ruft Details für einen angegebenen Nachbearbeitungscode ab.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/wrapup/code/{code_id}

Standard-URL: /api/now/wrapup/code/{code_id}

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
code_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. 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 : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. 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-Antwortcodes der REST-API.

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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)

Name	Beschreibung
Ergebnis	Objekt mit Informationen zur API-Anforderung und zum Nachbearbeitungscode. Datentyp: Objekt "result": { "message": "String", "resultMap": {Object}, "success": Boolean }
result.message	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
result.result_map	Objekt mit dem Nachbearbeitungscode. Datentyp: Objekt "result_map": { "wrap_up_code": {Object} }
result.result_map.wrap_up_code	Objekt mit Details zum Nachbearbeitungscode. Datentyp: Objekt "wrap_up_code": { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" }
result.result_map.wrap_up_code.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
result.result_map.wrap_up_code.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
result.result_map.wrap_up_code.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
result.result_map.wrap_up_code.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
result.result_map.wrap_up_code.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
result.result_map.wrap_up_code.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
result.result_map.wrap_up_code.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
Ergebnis.Erfolg	Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte: wahr: Die API-Anforderung war erfolgreich. „falsch“: Die API-Anforderung ist fehlgeschlagen. Datentyp: Boolesch

cURL-Anforderung

In diesem Beispiel werden Details für einen angegebenen Wrapup-Code abgerufen.

curl "https://instance.service-now.com/api/now/v1/wrapup/code/49c27b679f201210c89656effa0a1cd7" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
  "result": {
    "message": "Wrap up code found.",
    "result_map": {
      "wrap_up_code": {
        "code": "Billing Issue",
        "description": "A code for billing issues",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": "Ein code für Abrechnungsprobleme"
      }
    },
    "success": true
  }
}

Nachbearbeitung – GET /now/wrapup/segment/{segment_id}

Ruft Details für ein angegebenes Wrapup-Segment ab.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/wrapup/segment/{segment_id}

Standard-URL: /api/now/wrapup/segment/{segment_id}

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
segment_id	Sys_id des Nachbearbeitungssegments in der Tabelle „Interaktionsnachbearbeitungssegment“ [interaction_wrap_up_segment] oder Bezeichner, der das Interaktionssegment im externen System darstellt. 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

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-Antwortcodes der REST-API.

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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)

Name	Beschreibung
Nachricht	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
Segment	Objekt, das Daten zur Interaktion und zum Nachbearbeitungssegment enthält. Datentyp: Objekt "segment": { "agent": "String", "awaiting_confirmation": Boolean, "confirmed_on": "String", "external": Boolean, "interaction": "String", "opened_on": "String", "segmented": Boolean, "segment_id": "String", "segment_table": "String", "state": "String", "submitted_on": "String", "sys_id": "String", "wrap_up_configuration": {Object} }
segment.agent	Sys_id des Service Desk-Mitarbeiters, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
segment.waiting_confirmation	Kennzeichnung, die angibt, ob das vom Service Desk-Mitarbeiter übermittelte Wrap-up-Segment auf die Bestätigung wartet, dass es vom externen CCaaS-System verarbeitet wurde. Gültige Werte: „wahr“: Das Nachbearbeitungssegment wartet auf Bestätigung. „falsch“: Das Wrap-up-Segment wurde vom externen System verarbeitet. Datentyp: Boolesch
segment.confirmed_on	Zeitpunkt (Datum und Uhrzeit), zu dem das übermittelte Wrapup-Segment im externen CCaaS-System verarbeitet wird Datentyp: Zeichenfolge
segment.external	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: true: Das Interaktionssegment stammt aus einem externen System. „falsch“: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaktion	Sys_id der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [interaction]
segment.opened_on	Startdatum und -uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System. Datentyp: Zeichenfolge
segment.segmented	Kennzeichnung, die angibt, ob die Nachbearbeitung segmentiert ist. Gültige Werte: „wahr“: Die Nachbearbeitung ist in mehrere Teile unterteilt. „falsch“: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	Sys_id des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_tabelle	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
segment.status	Status des Interaktionssegments. Datentyp: Zeichenfolge
segment.submitted_on	Zeitpunkt (Datum und Uhrzeit), zu dem der Service Desk-Mitarbeiter das Nachbearbeitungssegment übermittelt hat. Datentyp: Zeichenfolge
segment.sys_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]
segment.wrap_up_configuration	Objekt mit Details zur Wrap-up-Konfiguration, die für das Wrap-up-Segment verwendet wird. Datentyp: Objekt "wrap_up_configuration": { "allowed_codes": [Array], "default_code": {Object}, "enable_codes": Boolean }
segment.wrap_up_configuration.allowed_codes	Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf Datentyp: Array "allowed_codes": [ { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" } ]
segment.wrap_up_configuration.allowed_codes.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.allowed_codes.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.allowed_codes.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.allowed_codes.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code	Objekt, das den als Standard zu verwendenden Nachbearbeitungscode enthält. Datentyp: Objekt "default_code": { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" }
segment.wrap_up_configuration.default_code.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.default_code.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.default_code.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.default_code.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.enable_codes	Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte: wahr: Der Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. „falsch“: Der Service Desk-Mitarbeiter muss keinen Nachbearbeitungscode auswählen. Datentyp: Boolesch Standardwert: false
segment_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]
Erfolg	Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte: wahr: Die API-Anforderung war erfolgreich. „falsch“: Die API-Anforderung ist fehlgeschlagen. Datentyp: Boolesch

cURL-Anforderung

In diesem Beispiel werden Details für ein angegebenes Wrapup-Segment abgerufen.

curl "https://instance.service-now.com/api/now/v1/wrapup/segment/dgajbcef12345678defdbxef123435678" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

Nachbearbeitung – GET /now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

Ruft Details für ein Wrap-up-Segment basierend auf einem angegebenen Service Desk-Mitarbeiter und einer Interaktion ab.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

Standard-URL: /api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

Unterstützte Anforderungsparameter

Tabelle : 13. 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
agent_id	Sys_id des Service Desk-Mitarbeiters, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
interaction_id	Sys_id der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [interaction]

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. 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 : 16. Anforderungskopfzeilen

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

Tabelle : 17. 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-Antwortcodes der REST-API.

Tabelle : 18. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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)

Name	Beschreibung
Nachricht	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
Segment	Objekt, das Daten zur Interaktion und zum Nachbearbeitungssegment enthält. Datentyp: Objekt "segment": { "agent": "String", "awaiting_confirmation": Boolean, "confirmed_on": "String", "external": Boolean, "interaction": "String", "opened_on": "String", "segmented": Boolean, "segment_id": "String", "segment_table": "String", "state": "String", "submitted_on": "String", "sys_id": "String", "wrap_up_configuration": {Object} }
segment.agent	Sys_id des Service Desk-Mitarbeiters, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
segment.waiting_confirmation	Kennzeichnung, die angibt, ob das vom Service Desk-Mitarbeiter übermittelte Wrap-up-Segment auf die Bestätigung wartet, dass es vom externen CCaaS-System verarbeitet wurde. Gültige Werte: „wahr“: Das Nachbearbeitungssegment wartet auf Bestätigung. „falsch“: Das Wrap-up-Segment wurde vom externen System verarbeitet. Datentyp: Boolesch
segment.confirmed_on	Zeitpunkt (Datum und Uhrzeit), zu dem das übermittelte Wrapup-Segment im externen CCaaS-System verarbeitet wird Datentyp: Zeichenfolge
segment.external	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: true: Das Interaktionssegment stammt aus einem externen System. „falsch“: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaktion	Sys_id der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [interaction]
segment.opened_on	Startdatum und -uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System. Datentyp: Zeichenfolge
segment.segmented	Kennzeichnung, die angibt, ob die Nachbearbeitung segmentiert ist. Gültige Werte: „wahr“: Die Nachbearbeitung ist in mehrere Teile unterteilt. „falsch“: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	Sys_id des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_tabelle	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
segment.status	Status des Interaktionssegments. Datentyp: Zeichenfolge
segment.submitted_on	Zeitpunkt (Datum und Uhrzeit), zu dem der Service Desk-Mitarbeiter das Nachbearbeitungssegment übermittelt hat. Datentyp: Zeichenfolge
segment.sys_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]
segment.wrap_up_configuration	Objekt mit Details zur Wrap-up-Konfiguration, die für das Wrap-up-Segment verwendet wird. Datentyp: Objekt "wrap_up_configuration": { "allowed_codes": [Array], "default_code": {Object}, "enable_codes": Boolean }
segment.wrap_up_configuration.allowed_codes	Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf Datentyp: Array "allowed_codes": [ { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" } ]
segment.wrap_up_configuration.allowed_codes.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.allowed_codes.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.allowed_codes.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.allowed_codes.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code	Objekt, das den als Standard zu verwendenden Nachbearbeitungscode enthält. Datentyp: Objekt "default_code": { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" }
segment.wrap_up_configuration.default_code.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.default_code.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.default_code.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.default_code.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.enable_codes	Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte: wahr: Der Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. „falsch“: Der Service Desk-Mitarbeiter muss keinen Nachbearbeitungscode auswählen. Datentyp: Boolesch Standardwert: false
segment_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]
Erfolg	Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte: wahr: Die API-Anforderung war erfolgreich. „falsch“: Die API-Anforderung ist fehlgeschlagen. Datentyp: Boolesch

cURL-Anforderung

In diesem Beispiel werden Details für ein Wrap-up-Segment basierend auf einem angegebenen Service Desk-Mitarbeiter und einer Interaktion abgerufen.

curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/123412345678567890ab90abcdefcdef/interaction/213412345678567890ab90abcdefcdef" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

Nachbearbeitung – POST /now/wrapup/code

Erstellt oder aktualisiert Wrapup-Codes.

Nachbearbeitungscodes werden in der Tabelle „Nachbearbeitungscode für Interaktion“ [interaction_wrap_up_code] erstellt.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/wrapup/code

Standard-URL: /api/now/wrapup/code

Unterstützte Anforderungsparameter

Tabelle : 19. 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 : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Codes	Erforderlich. Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen. Datentyp: Array "codes": [ { "active": Boolean, "code": "String", "description": "String", "translations": [Array] } ]
codes.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
codes.code	Erforderlich. Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
Codes.Beschreibung	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
codes.translations	Array von Objekten, die jeweils eine Übersetzung des Nachbearbeitungscodes darstellen. Datentyp: Array "translations": [ { "code": "Abrechnungsproblem", "description": "Ein code für Abrechnungsprobleme", "language": "de" } ]
codes.translations.code	Eine Übersetzung der Wrap-up-Codebezeichnung (codes.code). Erforderlich, wenn der Parameter codes.translations verwendet wird. Datentyp: Zeichenfolge
codes.translations.description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes (codes.description). Erforderlich, wenn der Parameter codes.translations verwendet wird und ein Wert für codes.descriptionangegeben wurde. Datentyp: Zeichenfolge
codes.translations.language (Codes.Übersetzungen.Sprache).	Zweibuchstabiger Code für die in der Übersetzung verwendete Sprache. Erforderlich, wenn der Parameter codes.translations verwendet wird. 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 : 22. 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 : 23. 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-Antwortcodes der REST-API.

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
207	Erfolgreich. Einige Nachbearbeitungscodes wurden erfolgreich erstellt. Beim Erstellen der weiteren sind Validierungsfehler aufgetreten.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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)

Name	Beschreibung
Ergebnis	Objekt mit Informationen zur API-Anforderung und den erstellten Nachbearbeitungscodes. Datentyp: Objekt "result": { "message": "String", "resultMap": {Object}, "success": Boolean }
result.message	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
result.result_map	Objekt, das ein Array erstellter Nachbearbeitungscodes enthält. Datentyp: Objekt "result_map": { "created_wrap_up_codes": [Array] }
result.result_map.created_wrap_up_codes	Array von Objekten, die jeweils einen erstellten Nachbearbeitungscode darstellen. Datentyp: Array "created_wrap_up_codes": [ { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" } ]
result.result_map.created_wrap_up_codes.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
result.result_map.created_wrap_up_codes.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
result.result_map.created_wrap_up_codes.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
result.result_map.created_wrap_up_codes.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
result.result_map.created_wrap_up_codes.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
result.result_map.created_wrap_up_codes.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
result.result_map.created_wrap_up_codes.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
Ergebnis.Erfolg	Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte: wahr: Die API-Anforderung war erfolgreich. „falsch“: Die API-Anforderung ist fehlgeschlagen. Datentyp: Boolesch

cURL-Anforderung

In diesem Beispiel wird ein Nachbearbeitungscode für Abrechnungsprobleme mit einer Übersetzung ins Deutsch erstellt.

curl "https://instance.service-now.com/api/now/v1/wrapup/code" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"codes\": [
    {
      \"code\": \"Billing Issue\",
      \"description\": \"A code for billing issues\",
      \"translations\": [
        {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\",
          \"description\": \"Ein code für Abrechnungsprobleme\"
        }
      ]
    }
  ]
}" \
--user 'username':'password'

Antworttext.

{
  "result": {
    "message": "All wrap up codes created successfully.",
    "result_map": {
      "created_wrap_up_codes": [
        {
          "code": "Billing Issue",
          "description": "A code for billing issues",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": "Ein code für Abrechnungsprobleme"
        }
      ]
    },
    "success": true
  }
}

Nachbearbeitung: POST /now/wrapup/segment/create

Öffnet ein Wrap-up-Segment für eine Interaktion.

Nachbearbeitungen werden in der Tabelle „Interaktionsnachbearbeitungssegment“ [interaction_wrap_up_segment] erstellt.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/wrapup/segment/create

Standard-URL: /api/now/wrapup/segment/create

Unterstützte Anforderungsparameter

Tabelle : 25. 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 : 26. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 27. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
agent_sys_id	Erforderlich. Sys_id des Service Desk-Mitarbeiters, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
konfigurieren	Objekt mit den Code- und Dauerdetails für eine externe Nachbearbeitung. Erforderlich, wenn external„wahr“ist. Datentyp: Objekt "configuration": { "allowed_codes": [Array], "default_code": "String", "duration": "String", "enable_codes": Boolean }
Configuration.allowed_codes	Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf Erforderlich, wenn external und configuration.enable_codes beide „wahr“sind. Datentyp: Array "allowed_codes": [ { "code": "String", "translation": {Object} } ]
Configuration.allowed_codes.code	Bezeichnung des Nachbearbeitungscodes. Erforderlich, wenn der Parameter configuration.allowed_codes verwendet wird. Datentyp: Zeichenfolge
„configuration.allowed_codes.translation“	Eine Übersetzung des Nachbearbeitungscodes. Datentyp: Objekt "translation": { "code": "String", "language": "String" }
Configuration.allowed_codes.translation.code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
Configuration.allowed_codes.translation.language	Zweibuchstabiger Code für die in der Übersetzung verwendete Sprache. Datentyp: Zeichenfolge
Configuration.default_code	Bezeichnung des Wrap-up-Codes, der als Standard verwendet werden soll. Erforderlich, wenn external und configuration.enable_codes beide „wahr“sind. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code] Feld: Code
Konfiguration.Dauer	Maximal zulässige Nachbearbeitungsdauer. Datentyp: Zeichenfolge Einheit: Sekunden Standard: Leere Zeichenfolge (keine Zeitbegrenzung).
Configuration.enable_codes	Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte: wahr: Der Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. „falsch“: Der Service Desk-Mitarbeiter muss keinen Nachbearbeitungscode auswählen. Datentyp: Boolesch Standardwert: false
external	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: true: Das Interaktionssegment stammt aus einem externen System. „falsch“: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
external_segment_id	Bezeichner, der das Interaktionssegment im externen System darstellt. Erforderlich, wenn external„wahr“ist. Datentyp: Zeichenfolge
interaction_sys_id	Erforderlich. Sys_id der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [interaction]
opened_on	Startdatum und -uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System. Erforderlich, wenn der Parameter configuration.duration verwendet wird. Datentyp: Zeichenfolge
segmentiert	Kennzeichnung, die angibt, ob die Nachbearbeitung segmentiert ist. Gültige Werte: „wahr“: Die Nachbearbeitung ist in mehrere Teile unterteilt. „falsch“: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment_id	Sys_id des Interaktionssegments. Erforderlich, wenn external und segmented beide „wahr“sind. Hinweis: Sie müssen den geskripteten Erweiterungspunkt „InteractionSegment“ implementieren, um Segmentdatensätze in der ausgewählten Tabelle zu erstellen und abzurufen, oder die OpenFrame- Implementierung verwenden, um Segmentdatensätze in der Tabelle „Telefonprotokoll“ [sn_openframe_phone_log] zu erstellen und abzurufen. Datentyp: Zeichenfolge
segment_table	Name der Tabelle, die das Interaktionssegment enthält. Erforderlich, wenn external und segmented beide „wahr“sind. Datentyp: Zeichenfolge
Wrap_up_configuration_sys_id	Sys_id der zu verwendenden Wrapup-Konfiguration. Erforderlich, wenn externalfalseist. Datentyp: Zeichenfolge Tabelle: Konfiguration der Interaktionsnachbearbeitung [interaction_wrap_up_configuration]

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 : 28. 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 : 29. 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-Antwortcodes der REST-API.

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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)

Name	Beschreibung
Nachricht	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
Segment	Objekt, das Daten zur Interaktion und zum Nachbearbeitungssegment enthält. Datentyp: Objekt "segment": { "agent": "String", "external": Boolean, "interaction": "String", "opened_on": "String", "segmented": Boolean, "segment_id": "String", "segment_table": "String", "state": "String", "sys_id": "String", "wrap_up_configuration": {Object} }
segment.agent	Sys_id des Service Desk-Mitarbeiters, der dem Interaktionssegment zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
segment.external	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: true: Das Interaktionssegment stammt aus einem externen System. „falsch“: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaktion	Sys_id der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [interaction]
segment.opened_on	Startdatum und -uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System. Datentyp: Zeichenfolge
segment.segmented	Kennzeichnung, die angibt, ob die Nachbearbeitung segmentiert ist. Gültige Werte: „wahr“: Die Nachbearbeitung ist in mehrere Teile unterteilt. „falsch“: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	Sys_id des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_tabelle	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
segment.status	Status des Interaktionssegments. Interaktionssegmente, die von der WrapUp -API erfolgreich erstellt werden, befinden sich im Status „Offen“. Datentyp: Zeichenfolge
segment.sys_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]
segment.wrap_up_configuration	Objekt mit Details zur Wrap-up-Konfiguration, die für das Wrap-up-Segment verwendet wird. Datentyp: Objekt "wrap_up_configuration": { "allowed_codes": [Array], "default_code": {Object}, "enable_codes": Boolean }
segment.wrap_up_configuration.allowed_codes	Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf Datentyp: Array "allowed_codes": [ { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" } ]
segment.wrap_up_configuration.allowed_codes.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.allowed_codes.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.allowed_codes.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.allowed_codes.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code	Objekt, das den als Standard zu verwendenden Nachbearbeitungscode enthält. Datentyp: Objekt "default_code": { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" }
segment.wrap_up_configuration.default_code.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.default_code.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.default_code.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.default_code.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.enable_codes	Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte: wahr: Der Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. „falsch“: Der Service Desk-Mitarbeiter muss keinen Nachbearbeitungscode auswählen. Datentyp: Boolesch Standardwert: false
Erfolg	Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte: wahr: Die API-Anforderung war erfolgreich. „falsch“: Die API-Anforderung ist fehlgeschlagen. Datentyp: Boolesch
sys_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]

cURL-Anforderung

In diesem Beispiel wird ein Wrap-up-Segment für eine Interaktion geöffnet.

curl "https://instance.service-now.com/api/now/v1/wrapup/segment/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"agent_sys_id\": \"123412345678567890ab90abcdefcdef\",
  \"interaction_sys_id\": \"213412345678567890ab90abcdefcdef\",
  \"external\": \"true\",
  \"segmented\": \"true\",
  \"segment_table\": \"sn_openframe_phone_log\",
  \"segment_id\": \"dgajbcef12345678defdbxef123435678\",
  \"external_segment_id\": \"PL_402548\",
  \"configuration\": {
    \"enable_codes\": true,
    \"allowed_codes\": [
      {
        \"code\": \"Billing Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\"
        }
      },
      {
        \"code\": \"Store Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Einkaufsproblem\"
        }
      }
    ],
    \"default_code\": \"Billing Issue\",
    \"duration\": \"30\"
  },
  \"opened_on\": \"2024-09-16 17:52:01\"
}" \
--user 'username':'password'

Antworttext.

{
  "success": true,
  "message": "Open wrap-up segment successfully created.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "open",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "98769876543254321fed1fedcba0cba0",
    "opened_on": "2024-09-16 17:52:01"
  }
}

Nachbearbeitung: PUT /now/wrapup/segment/update

Aktualisiert und schließt ein Wrap-up-Segment für eine Interaktion.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/wrapup/segment/update

Standard-URL: /api/now/wrapup/segment/update

Unterstützte Anforderungsparameter

Tabelle : 31. 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 : 32. Abfrageparameter

Name	Beschreibung
agent_sys_id	Sys_id des Service Desk-Mitarbeiters, der der Interaktion zugewiesen ist. Zusammen mit interaction_sys_id erforderlich, wenn weder segment_sys_id noch external_segment_id angegeben sind. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
external_segment_id	Bezeichner, der das Interaktionssegment im externen System darstellt. Wird verwendet, um das zu aktualisierende Wrapup-Segment zu identifizieren, wenn segment_sys_id nicht angegeben ist.
interaction_sys_id	Sys_id der Interaktion. Zusammen mit agent_sys_id erforderlich, wenn weder segment_sys_id noch external_segment_id angegeben sind. Datentyp: Zeichenfolge Tabelle: Interaktion [interaction]
segment_sys_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]

Tabelle : 33. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Bestätigt_am	Enddatum und -uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System. Datentyp: Zeichenfolge
Notizen	Zusätzliche Hinweise, die der Service Desk-Mitarbeiter der Nachbearbeitung hinzugefügt hat. Datentyp: Zeichenfolge
Wrap_up_code	Bezeichnung des vom Service Desk-Mitarbeiter ausgewählten Nachbearbeitungscodes. Wenn der Service Desk-Mitarbeiter keinen Code auswählt, wird der konfigurierte Standardcode verwendet. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code] Feld: Code

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 : 34. 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 : 35. 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-Antwortcodes der REST-API.

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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)

Name	Beschreibung
Nachricht	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
Segment	Objekt, das Daten zur Interaktion und zum Nachbearbeitungssegment enthält. Datentyp: Objekt "segment": { "agent": "String", "awaiting_confirmation": Boolean, "code": {Object}, "confirmed_on": "String", "external": Boolean, "interaction": "String", "notes": "String", "opened_on": "String", "segmented": Boolean, "segment_id": "String", "segment_table": "String", "state": "String", "submitted_on": "String", "sys_id": "String", "wrap_up_configuration": {Object} }
segment.agent	Sys_id des Service Desk-Mitarbeiters, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
segment.waiting_confirmation	Kennzeichnung, die angibt, ob das vom Service Desk-Mitarbeiter übermittelte Wrap-up-Segment auf die Bestätigung wartet, dass es vom externen CCaaS-System verarbeitet wurde. Gültige Werte: „wahr“: Das Nachbearbeitungssegment wartet auf Bestätigung. „falsch“: Das Wrap-up-Segment wurde vom externen System verarbeitet. Datentyp: Boolesch
segment.code	Objekt, das den vom Service Desk-Mitarbeiter ausgewählten Nachbearbeitungscode enthält. Datentyp: Objekt "code": { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" }
segment.code.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.code.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.code.beschreibung	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.code.extern	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.code.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.code.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.code.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.confirmed_on	Zeitpunkt (Datum und Uhrzeit), zu dem das übermittelte Wrapup-Segment im externen CCaaS-System verarbeitet wird Datentyp: Zeichenfolge
segment.external	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: true: Das Interaktionssegment stammt aus einem externen System. „falsch“: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaktion	Sys_id der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [interaction]
segment.notes	Zusätzliche Hinweise, die der Service Desk-Mitarbeiter der Nachbearbeitung hinzugefügt hat. Datentyp: Zeichenfolge
segment.opened_on	Startdatum und -uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System. Datentyp: Zeichenfolge
segment.segmented	Kennzeichnung, die angibt, ob die Nachbearbeitung segmentiert ist. Gültige Werte: „wahr“: Die Nachbearbeitung ist in mehrere Teile unterteilt. „falsch“: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	Sys_id des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_tabelle	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
segment.status	Status des Interaktionssegments. Interaktionssegmente, die von diesem Endpunkt erfolgreich aktualisiert werden, befinden sich im Status „Geschlossen“. Datentyp: Zeichenfolge
segment.submitted_on	Zeitpunkt (Datum und Uhrzeit), zu dem der Service Desk-Mitarbeiter das Nachbearbeitungssegment übermittelt hat. Datentyp: Zeichenfolge
segment.sys_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]
segment.wrap_up_configuration	Objekt mit Details zur Wrap-up-Konfiguration, die für das Wrap-up-Segment verwendet wird. Datentyp: Objekt "wrap_up_configuration": { "allowed_codes": [Array], "default_code": {Object}, "enable_codes": Boolean }
segment.wrap_up_configuration.allowed_codes	Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf Datentyp: Array "allowed_codes": [ { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" } ]
segment.wrap_up_configuration.allowed_codes.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.allowed_codes.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.allowed_codes.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.allowed_codes.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.allowed_codes.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code	Objekt, das den als Standard zu verwendenden Nachbearbeitungscode enthält. Datentyp: Objekt "default_code": { "active": Boolean, "code": "String", "description": "String", "external": Boolean, "sys_id": "String", "translated_code": "String", "translated_description": "String" }
segment.wrap_up_configuration.default_code.active	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte: wahr: Der Nachbearbeitungscode ist aktiv. „falsch“: Der Nachbearbeitungscode ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
segment.wrap_up_configuration.default_code.code	Bezeichnung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.external	Kennzeichnung, die angibt, ob der Nachbearbeitungscode aus einem externen System stammt. Gültige Werte: wahr: Der Nachbearbeitungscode stammt aus einem externen System. „falsch“: Der Nachbearbeitungscode ist intern. Datentyp: Boolesch
segment.wrap_up_configuration.default_code.sys_id	Sys_id des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungscode [interaction_wrap_up_code]
segment.wrap_up_configuration.default_code.translated_code	Eine Übersetzung der Nachbearbeitungscode-Bezeichnung. Datentyp: Zeichenfolge
segment.wrap_up_configuration.default_code.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
segment.wrap_up_configuration.enable_codes	Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte: wahr: Der Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. „falsch“: Der Service Desk-Mitarbeiter muss keinen Nachbearbeitungscode auswählen. Datentyp: Boolesch Standardwert: false
Erfolg	Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte: wahr: Die API-Anforderung war erfolgreich. „falsch“: Die API-Anforderung ist fehlgeschlagen. Datentyp: Boolesch
sys_id	Sys_id des Wrap-Up-Segments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment]

cURL-Anforderung

In diesem Beispiel wird ein Wrap-up-Segment für eine Interaktion aktualisiert und geschlossen.

curl "https://instance.service-now.com/api/now/v1/wrapup/segment/update?segment_sys_id=98769876543254321fed1fedcba0cba0&agent_sys_id=123412345678567890ab90abcdefcdef&interaction_sys_id=213412345678567890ab90abcdefcde" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"wrap_up_code\": \"Billing Issue\",
  \"notes\": \"Customer's credit card expired. Had to switch to another one.\",
  \"confirmed_on\": \"2024-09-16 18:52:01\"
}" \
--user 'username':'password'

Antworttext.

{
  "success": true,
  "message": "Wrap-up segment updated successfully.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "code": {
      "code": "Billing Issue",
      "description": "",
      "active": true,
      "external": true,
      "sys_id": "49c27b679f201210c89656effa0a1cd7",
      "translated_code": "Abrechnungsproblem",
      "translated_description": ""
    },
    "notes": "Customer's credit card expired. Had to switch to another one.",
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}