API zum Abschließen

Die Abschluss Die API stellt Endpunkte für die Verwaltung der Nachbearbeitungsfunktionen für externe Contact Center as a Service (CCaaS)-Systeme oder bereit ServiceNow AI Platform Arbeitsbereiche.

Diese API erfordert das Plugin Interaktionsmanagement (com.glide.interaction). Um diese API aufzurufen, müssen Sie über die Rolle Interaction_Integration_user verfügen.

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

Zur Verwendung von Abschluss API für die segmentierte Nachbearbeitung von Interaktionen aus externen Systemen müssen Sie den skriptbasierten InteractionSegment-Erweiterungspunkt implementieren, um Segmentdatensätze in der ausgewählten Tabelle zu erstellen und abzurufen. Wenn Sie verwenden OpenFrame , Der Erweiterungspunkt verfügt über eine vorhandene Implementierung zum Erstellen und Abrufen von Segmentdatensätzen in der Tabelle „Telefonprotokoll“ [sn_openframe_Phone_log].

Abschluss – GET /now/wrapup/Code/{Code_ID}

Ruft Details für einen angegebenen Nachbearbeitungscode ab.

URL-Format

Versionierte URL: /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. 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 REST API-HTTP-Antwortcodes .

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.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Ergebnis	Objekt mit Informationen zur API-Anforderung und zum Nachbearbeitungscode. Datentyp: Objekt "result": { "message": "String", "resultMap": {Object}, "success": Boolean }
Ergebnis.Nachricht	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
Ergebnis.Ergebnis_Zuordnung	Objekt, das den Nachbearbeitungscode enthält. Datentyp: Objekt "result_map": { "wrap_up_code": {Object} }
Ergebnis.Ergebnis_Karte.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
Ergebnis.Ergebnis_Karte.Wrap_up_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
Ergebnis.Ergebnis_Karte.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 Nachbearbeitungscodebezeichnung. 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 Nachbearbeitungscode 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
  }
}

Abschluss – GET /now/wrapup/Segment/{Segment_ID}

Ruft Details für ein angegebenes Nachbearbeitungssegment ab.

URL-Format

Versionierte URL: /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. 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 REST API-HTTP-Antwortcodes .

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.

Antworttext-Parameter (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.Warten_Bestätigung	Kennzeichnung, die angibt, ob das vom Service Desk-Mitarbeiter übermittelte Nachbearbeitungssegment 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 Nachbearbeitungssegment wurde vom externen System verarbeitet. Datentyp: Boolesch
Segment.Confirmed_on	Datum und Uhrzeit, zu der das übermittelte Nachbearbeitungssegment im externen CCaaS-System verarbeitet wird. Datentyp: Zeichenfolge
Segment.extern	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: Wahr: Das Interaktionssegment stammt aus einem externen System. Falsch: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaction	SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion]
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 segmentiert. Falsch: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	SYS_ID des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_table	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
Segment.Status	Status des Interaktionssegments. Datentyp: Zeichenfolge
Segment.submitted_on	Datum und Uhrzeit, zu der der Service Desk-Mitarbeiter das Nachbearbeitungssegment übermittelt hat. Datentyp: Zeichenfolge
Segment.sys_ID	SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [Interaction_wrap_up_Segment]
Segment.wrap_up_Configuration	Objekt mit Details zur Nachbearbeitungskonfiguration, die für das Nachbearbeitungssegment 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 Nachbearbeitungscodebezeichnung. 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 Nachbearbeitungscode enthält, der als Standard verwendet werden soll. 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 Nachbearbeitungscodebezeichnung. 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: Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. Falsch: Service Desk-Mitarbeiter muss keinen Nachbearbeitungscode auswählen. Datentyp: Boolesch Standardwert: false
Segment_ID	SYS_ID des Nachbearbeitungssegments. 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 Nachbearbeitungssegment 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
  }
}

Abschluss – GET /now/wrapup/Segment/Agent/{Agent_ID}/Interaction/{Interaction_ID}

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

URL-Format

Versionierte URL: /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. 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 [Interaktion]

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

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.

Antworttext-Parameter (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.Warten_Bestätigung	Kennzeichnung, die angibt, ob das vom Service Desk-Mitarbeiter übermittelte Nachbearbeitungssegment 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 Nachbearbeitungssegment wurde vom externen System verarbeitet. Datentyp: Boolesch
Segment.Confirmed_on	Datum und Uhrzeit, zu der das übermittelte Nachbearbeitungssegment im externen CCaaS-System verarbeitet wird. Datentyp: Zeichenfolge
Segment.extern	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: Wahr: Das Interaktionssegment stammt aus einem externen System. Falsch: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaction	SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion]
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 segmentiert. Falsch: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	SYS_ID des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_table	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
Segment.Status	Status des Interaktionssegments. Datentyp: Zeichenfolge
Segment.submitted_on	Datum und Uhrzeit, zu der der Service Desk-Mitarbeiter das Nachbearbeitungssegment übermittelt hat. Datentyp: Zeichenfolge
Segment.sys_ID	SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [Interaction_wrap_up_Segment]
Segment.wrap_up_Configuration	Objekt mit Details zur Nachbearbeitungskonfiguration, die für das Nachbearbeitungssegment 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 Nachbearbeitungscodebezeichnung. 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 Nachbearbeitungscode enthält, der als Standard verwendet werden soll. 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 Nachbearbeitungscodebezeichnung. 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: Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. Falsch: Service Desk-Mitarbeiter muss keinen Nachbearbeitungscode auswählen. Datentyp: Boolesch Standardwert: false
Segment_ID	SYS_ID des Nachbearbeitungssegments. 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

Dieses Beispiel ruft Details für ein Nachbearbeitungssegment basierend auf einem angegebenen Service Desk-Mitarbeiter und einer angegebenen Interaktion ab.

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
  }
}

Abschluss: VERÖFFENTLICHEN SIE /now/wrapup/Code

Erstellt oder aktualisiert Nachbearbeitungscodes.

Nachbearbeitungscodes werden in der Tabelle „Interaction-Nachbearbeitungscode“ [Interaction_wrap_up_Code] erstellt.

URL-Format

Versionierte URL: /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. 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.aktiv	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.description	Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
Codes.Übersetzungen	Array von Objekten, die jeweils eine Übersetzung des Nachbearbeitungscodes darstellen. Datentyp: Array "translations": [ { "code": "Abrechnungsproblem", "description": "Ein code für Abrechnungsprobleme", "language": "de" } ]
Codes.Übersetzungen.Code	Eine Übersetzung der Nachbearbeitungscodebezeichnung ( codes.code). Erforderlich, wenn verwendet wird codes.translationsParameter. Datentyp: Zeichenfolge
codes.translations.description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes ( codes.description). Erforderlich, wenn verwendet wird codes.translationsParameter und ein Wert wurden für angegeben codes.description. Datentyp: Zeichenfolge
Codes.Übersetzungen.Sprache	Zweistelliger Code für die in der Übersetzung verwendete Sprache. Erforderlich, wenn verwendet wird codes.translationsParameter. 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
Inhaltstyp	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 REST API-HTTP-Antwortcodes .

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
207	Erfolgreich. Einige Nachbearbeitungscodes wurden erfolgreich erstellt. Beim Erstellen anderer 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.

Antworttext-Parameter (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 }
Ergebnis.Nachricht	Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge
Ergebnis.Ergebnis_Zuordnung	Objekt, das ein Array von erstellten Nachbearbeitungscodes enthält. Datentyp: Objekt "result_map": { "created_wrap_up_codes": [Array] }
Ergebnis.Ergebnis_Karte.erstellt_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
Ergebnis.Ergebnis_Karte.erstellt_Wrap_up_Codes.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
Ergebnis.Ergebnis_Karte.erstellt_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 Nachbearbeitungscodebezeichnung. 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 in 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: VERÖFFENTLICHEN SIE /now/wrapup/Segment/create

Öffnet ein Nachbearbeitungssegment für eine Interaktion.

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

URL-Format

Versionierte URL: /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. 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 externalIst Wahr . 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 externalUnd configuration.enable_codesSind beides Wahr . Datentyp: Array "allowed_codes": [ { "code": "String", "translation": {Object} } ]
Configuration.allowed_Codes.Code	Bezeichnung des Nachbearbeitungscodes.Erforderlich, wenn verwendet wird configuration.allowed_codesParameter. 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 Nachbearbeitungscodebezeichnung. Datentyp: Zeichenfolge
Configuration.allowed_Codes.Translation.language	Zweistelliger Code für die in der Übersetzung verwendete Sprache. Datentyp: Zeichenfolge
configuration.default_code	Bezeichnung des Nachbearbeitungscodes, der als Standard verwendet werden soll. Erforderlich, wenn externalUnd configuration.enable_codesSind beides Wahr . 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: Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. Falsch: 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: Wahr: 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 externalIst Wahr . Datentyp: Zeichenfolge
interaction_sys_id	Erforderlich. SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion]
Geöffnet_am	Startdatum und -Uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System.Erforderlich, wenn verwendet wird configuration.durationParameter. Datentyp: Zeichenfolge
Segmentiert	Kennzeichnung, die angibt, ob die Nachbearbeitung segmentiert ist. Gültige Werte: Wahr: Die Nachbearbeitung ist in mehrere Teile segmentiert. Falsch: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
Segment_ID	SYS_ID des Interaktionssegments. Erforderlich, wenn externalUnd segmentedSind beides Wahr . Hinweis: Sie müssen den skriptbasierten InteractionSegment-Erweiterungspunkt implementieren, um Segmentdatensätze in der ausgewählten Tabelle zu erstellen und abzurufen, oder verwenden Sie OpenFrame Implementierung zum Erstellen und Abrufen von Segmentdatensätzen in der Tabelle „Telefonprotokoll“ [sn_openframe_Phone_log]. Datentyp: Zeichenfolge
Segment_table	Name der Tabelle, die das Interaktionssegment enthält. Erforderlich, wenn externalUnd segmentedSind beides Wahr . Datentyp: Zeichenfolge
Wrap_up_Configuration_sys_ID	SYS_ID der zu verwendenden Nachbearbeitungskonfiguration. Erforderlich, wenn externalIst Falsch . 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
Inhaltstyp	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 REST API-HTTP-Antwortcodes .

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.

Antworttext-Parameter (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.extern	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: Wahr: Das Interaktionssegment stammt aus einem externen System. Falsch: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaction	SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion]
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 segmentiert. Falsch: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	SYS_ID des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_table	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
Segment.Status	Status des Interaktionssegments. Interaktionssegmente, die die sind Abschluss Erfolgreich erstellte API befinden sich im Status „Offen“. Datentyp: Zeichenfolge
Segment.sys_ID	SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [Interaction_wrap_up_Segment]
Segment.wrap_up_Configuration	Objekt mit Details zur Nachbearbeitungskonfiguration, die für das Nachbearbeitungssegment 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 Nachbearbeitungscodebezeichnung. 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 Nachbearbeitungscode enthält, der als Standard verwendet werden soll. 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 Nachbearbeitungscodebezeichnung. 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: Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. Falsch: 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 Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [Interaction_wrap_up_Segment]

cURL-Anforderung

In diesem Beispiel wird ein Nachbearbeitungssegment 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"
  }
}

Abschluss – PUT /now/wrapup/Segment/Update

Aktualisiert und schließt ein Nachbearbeitungssegment für eine Interaktion.

URL-Format

Versionierte URL: /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. 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. Erforderlich zusammen mit interaction_sys_idWenn keine der beiden segment_sys_idNoch nicht external_segment_idWerden bereitgestellt. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
External_Segment_ID	Bezeichner, der das Interaktionssegment im externen System darstellt. Wird verwendet, um das Nachbearbeitungssegment zu identifizieren, das aktualisiert werden soll segment_sys_idIst nicht angegeben.
interaction_sys_id	SYS_ID der Interaktion. Erforderlich zusammen mit agent_sys_idWenn keine der beiden segment_sys_idNoch nicht external_segment_idWerden bereitgestellt. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion]
Segment_sys_ID	SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [Interaction_wrap_up_Segment]

Tabelle : 33. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Confirmed_on	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
Inhaltstyp	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 REST API-HTTP-Antwortcodes .

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.

Antworttext-Parameter (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.Warten_Bestätigung	Kennzeichnung, die angibt, ob das vom Service Desk-Mitarbeiter übermittelte Nachbearbeitungssegment 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 Nachbearbeitungssegment 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.description	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 Nachbearbeitungscodebezeichnung. Datentyp: Zeichenfolge
Segment.Code.translated_description	Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge
Segment.Confirmed_on	Datum und Uhrzeit, zu der das übermittelte Nachbearbeitungssegment im externen CCaaS-System verarbeitet wird. Datentyp: Zeichenfolge
Segment.extern	Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte: Wahr: Das Interaktionssegment stammt aus einem externen System. Falsch: Das Interaktionssegment ist intern. Datentyp: Boolesch Standardwert: false
segment.interaction	SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion]
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 segmentiert. Falsch: Die Nachbearbeitung ist ein vollständiges Segment. Datentyp: Boolesch Standardwert: false
segment.segment_id	SYS_ID des Interaktionssegments. Datentyp: Zeichenfolge
segment.segment_table	Name der Tabelle, die das Interaktionssegment enthält. Datentyp: Zeichenfolge
Segment.Status	Status des Interaktionssegments. Interaktionssegmente, die dieser Endpunkt erfolgreich aktualisiert, befinden sich im Status „Geschlossen“. Datentyp: Zeichenfolge
Segment.submitted_on	Datum und Uhrzeit, zu der der Service Desk-Mitarbeiter das Nachbearbeitungssegment übermittelt hat. Datentyp: Zeichenfolge
Segment.sys_ID	SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [Interaction_wrap_up_Segment]
Segment.wrap_up_Configuration	Objekt mit Details zur Nachbearbeitungskonfiguration, die für das Nachbearbeitungssegment 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 Nachbearbeitungscodebezeichnung. 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 Nachbearbeitungscode enthält, der als Standard verwendet werden soll. 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 Nachbearbeitungscodebezeichnung. 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: Service Desk-Mitarbeiter muss einen Nachbearbeitungscode auswählen. Falsch: 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 Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [Interaction_wrap_up_Segment]

cURL-Anforderung

In diesem Beispiel wird ein Nachbearbeitungssegment 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
  }
}