Nachbearbeitungs-API
Stellt Endpunkte für die Verwaltung der Nachbearbeitungsfunktionen für externe CCaaS-Systeme (Contact Center as a Service) oder bereit ServiceNow AI Platform Arbeitsbereiche.
Diese API erfordert das Plugin „Interaktionsmanagement“ (com.glide.interaction.awa). 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.
Um diese API für die segmentierte Nachbearbeitung von Interaktionen aus externen Systemen zu verwenden, müssen Sie implementieren Interaktionssegment Geskripteter Erweiterungspunkt zum Erstellen und Abrufen von Segmentdatensätzen in der ausgewählten Tabelle. 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].
- KI-Abschlussempfehlungen
-
KI-Nachbearbeitungsempfehlungen können aus zwei Quellen stammen:
- Intern ( Now Assist): Wann use_third_party_aiIst „falsch“, wird nach der Segmenterstellung automatisch eine Business-Regel ausgelöst, um die CSM-API aufzurufen und auszufüllen ai_wrap_up_codeUnd ai_notes.
- Extern (Drittpartei/CCaaS): Wann use_third_party_aiIst „wahr“, sendet das externe System KI-Daten über die neue BEREITSTELLUNG /api/now/wrapup/Segment/Update/ai Endpunkt.
- Anwendungsfälle
-
- Reduzieren Sie die Bearbeitungszeit von Service Desk-Mitarbeitern, indem Sie Nachbearbeitungscodes und Notizen mit KI-Vorschlägen bereitstellen.
- Aktivieren Sie CCaaS-Plattformen, um KI-generierte Inhalte in zu veröffentlichen ServiceNow AI Platform Nachdem eine Interaktion endet.
- Geben Sie Vorgesetzten bereinigte, konsistentere Nachbearbeitungsdaten für Berichterstellung und Analytics an.
- Endpunkt-Anrufreihenfolge für einen KI-gestützten Nachbearbeitungs-Flow
-
- VERÖFFENTLICHEN /api/now/wrapup/Segment/create – Öffnen Sie ein Segment oder übergeben Sie es ai_wrap_up_code/ ai_notesUnd KI-Konfigurationskennzeichnungen.
- PLATZIEREN /api/now/wrapup/Segment/Update/ai – (Nur externe KI) KI-Empfehlungen auf das offene Segment übertragen.
- PLATZIEREN /api/now/wrapup/Segment/Update – Service Desk-Mitarbeiter schließt das Segment ab und schließt es.
- ABRUFEN /api/now/wrapup/Segment/{Segment_ID} – Segment einschließlich gespeicherter KI-Felder abrufen.
Nachbearbeitung – 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
| 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: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt mit Informationen zur API-Anforderung und zum Nachbearbeitungscode. Datentyp: Objekt |
| Ergebnis.Nachricht | Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis_Zuordnung | Objekt, das den Nachbearbeitungscode enthält. Datentyp: Objekt |
| result.result_map.wrap_up_code | Objekt mit Details zum Nachbearbeitungscode. Datentyp: Objekt |
| result.result_map.wrap_up_code.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| result.result_map.wrap_up_code.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| result.result_map.wrap_up_code.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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:
Datentyp: Boolesch |
cURL-Anforderung
Dieses Beispiel ruft Details für einen angegebenen Nachbearbeitungscode ab.
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 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
| 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge |
| Segment | Objekt mit Daten zur Interaktion und zum Nachbearbeitungssegment. Datentyp: Objekt |
| Segment.Agent | SYS_ID des Agenten, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| segment.ai_code_defined_at | Zeitstempel, wann KI-Code gespeichert wurde. Format: UNIX-Epoche Millisekunden (z. B. „1752252703000“) Datentyp: Zeichenfolge |
| Segment.ai_Notes | KI-generierte Notizen, die im Segment gespeichert sind. Datentyp: Zeichenfolge |
| segment.ai_notes_defined_at | Zeitstempel, zu dem KI-Notizen gespeichert wurden. Format: UNIX-Epoche Millisekunden Datentyp: Zeichenfolge |
| segment.ai_wrap_up_code | KI-empfohlener Code, der im Segment gespeichert ist. Datentyp: Zeichenfolge |
| 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:
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:
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:
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 |
| segment.wrap_up_configuration.allowed_codes | Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf. Datentyp: Array |
| segment.wrap_up_configuration.allowed_codes.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.allowed_codes.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.allowed_codes.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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 |
| segment.wrap_up_configuration.default_code.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.default_code.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. Datentyp: Zeichenfolge |
| segment.wrap_up_configuration.default_code.translated_description | Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge |
| segment.wrap_up_configuration.enable_ai_code | Kennzeichnung, die angibt, ob die Generierung von KI-Code für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.enable_ai_notes | Kennzeichnung, die angibt, ob die Generierung von KI-Notizen für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.enable_codes | Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| segment.wrap_up_configuration.use_ai_as_default | Kennzeichnung, die angibt, ob KI-Code automatisch als Standard-Nachbearbeitungscode für diese Konfiguration festgelegt wird. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.use_third_party_ai | Kennzeichnung, die angibt, ob die KI-Inhaltsquelle aus einem externen System einer Drittpartei stammt. Gültige Werte:
Datentyp: Boolesch |
| 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:
Datentyp: Boolesch |
cURL-Anforderung
Dieses Beispiel ruft Details für ein angegebenes Nachbearbeitungssegment ab.
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
}
}
Dieses Beispiel ruft Details für ein angegebenes Nachbearbeitungssegment ab, das für KI-Empfehlungen konfiguriert ist.
curl "https://instance.service-now.com/api/now/v1/wrapup/segment/abcd1234abcd1234abcd1234abcd1234" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext.
{
"success": true,
"message": "Segment retrieved.",
"segment_id": "abcd1234abcd1234abcd1234abcd1234",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"state": "closed",
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about an incorrect charge.",
"ai_code_defined_at": "1752252703000",
"ai_notes_defined_at": "1752252703000",
"wrap_up_configuration": {
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"use_third_party_ai": false
}
}
}
Nachbearbeitung – 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
| 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 Agenten, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| interaction_id | SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge |
| Segment | Objekt mit Daten zur Interaktion und zum Nachbearbeitungssegment. Datentyp: Objekt |
| Segment.Agent | SYS_ID des Agenten, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Segment.Agent | SYS_ID des Agenten, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| segment.ai_code_defined_at | Zeitstempel, wann KI-Code gespeichert wurde. Format: UNIX-Epoche Millisekunden (z. B. „1752252703000“) Datentyp: Zeichenfolge |
| Segment.ai_Notes | KI-generierte Notizen, die im Segment gespeichert sind. Datentyp: Zeichenfolge |
| segment.ai_notes_defined_at | Zeitstempel, zu dem KI-Notizen gespeichert wurden. Format: UNIX-Epoche Millisekunden Datentyp: Zeichenfolge |
| segment.ai_wrap_up_code | KI-empfohlener Code, der im Segment gespeichert ist. Datentyp: Zeichenfolge |
| 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:
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:
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:
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 |
| segment.wrap_up_configuration.allowed_codes | Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf. Datentyp: Array |
| segment.wrap_up_configuration.allowed_codes.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.allowed_codes.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.allowed_codes.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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 |
| segment.wrap_up_configuration.default_code.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.default_code.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. Datentyp: Zeichenfolge |
| segment.wrap_up_configuration.default_code.translated_description | Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge |
| segment.wrap_up_configuration.enable_ai_code | Kennzeichnung, die angibt, ob die Generierung von KI-Code für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.enable_ai_notes | Kennzeichnung, die angibt, ob die Generierung von KI-Notizen für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.enable_codes | Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| segment.wrap_up_configuration.use_ai_as_default | Kennzeichnung, die angibt, ob KI-Code automatisch als Standard-Nachbearbeitungscode für diese Konfiguration festgelegt wird. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.use_third_party_ai | Kennzeichnung, die angibt, ob die KI-Inhaltsquelle aus einem externen System einer Drittpartei stammt. Gültige Werte:
Datentyp: Boolesch |
| 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:
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
}
}
cURL-Anforderung
Dieses Beispiel ruft Details für ein Nachbearbeitungssegment ab, das für KI-Empfehlungen konfiguriert ist.
curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/987698761234123456xy12ghijklmnoqrst/interaction/879065432198432109xy34mnopqrstuv" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext.
{
"success": true,
"segment": {
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about incorrect charge.",
"ai_code_defined_at": "1752252703000",
"ai_notes_defined_at": "1752252703000",
"wrap_up_configuration": {
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"use_third_party_ai": false
}
}
}
Nachbearbeitung: VERÖFFENTLICHEN SIE /now/wrapup/Code
Erstellt oder aktualisiert Nachbearbeitungscodes.
Nachbearbeitungscodes werden in der Tabelle „Interaktionsnachbearbeitungscode“ [interaction_wrap_up_code] erstellt.
URL-Format
Versionierte URL: /api/now/{api_Version}/wrapup/Code
Standard-URL: /api/now/wrapup/Code
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Codes | Erforderlich. Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen. Datentyp: Array |
| Codes.aktiv | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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 |
| Codes.Übersetzungen.Code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode ( 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 Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | 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 |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 207 | Erfolgreich. Einige Nachbearbeitungscodes wurden erfolgreich erstellt. Validierungsfehler beim Erstellen anderer. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt mit Informationen zur API-Anforderung und den erstellten Nachbearbeitungscodes. Datentyp: Objekt |
| 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.result_map.created_wrap_up_codes | Array von Objekten, die jeweils einen erstellten Nachbearbeitungscode darstellen. Datentyp: Array |
| result.result_map.created_wrap_up_codes.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| result.result_map.created_wrap_up_codes.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| result.result_map.created_wrap_up_codes.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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:
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. Rufen Sie diesen Endpunkt zu Beginn des Nachbearbeitungszeitraums an.
Dieser Endpunkt unterstützt KI-generierte Nachbearbeitungscodes und Notizen direkt in der Anforderungsnutzlast und speichert die KI-Konfigurationskennzeichnungen in der Nachbearbeitungskonfiguration. Wenn externalIst auf festgelegt Falsch Und KI-Codes oder -Notizen sind in der Konfiguration aktiviert. Eine synchrone Business-Regel wird ausgeführt, nachdem das Segment erstellt wurde. Dieser Endpunkt ruft die interne CSM-API (NowAssist) auf und füllt die KI-Felder automatisch aus. Vom Anrufer ist keine zusätzliche Aktion erforderlich.
URL-Format
Versionierte URL: /api/now/{api_Version}/Wrapup/Segment/create
Standard-URL: /api/now/wrapup/Segment/create
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Agent_sys_ID | Erforderlich. SYS_ID des Agenten, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| ai_wrap_up_code | VON KI vorgeschlagene Nachbearbeitungscodebezeichnung. Automatisch ausgefüllt von Now Assist Wenn der Wert von use_third_party_aiIst Falsch Oder das Feld fehlt in der Konfiguration. Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment] Datentyp: Zeichenfolge |
| KI_Notes | KI-generierte Notizen. Maximale Länge: 4000 Zeichen Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment] Datentyp: Zeichenfolge |
| konfigurieren | Objekt mit den Code- und Dauerdetails für eine externe Nachbearbeitung. Erforderlich, wenn externalIst Wahr .Datentyp: Objekt |
| 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 |
| 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 |
| Configuration.allowed_Codes.Translation.Code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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: Interaktionsbearbeitungscode [interaction_wrap_up_code] Feld: Code |
| Konfiguration.Dauer | Maximal zulässige Nachbearbeitungsdauer. Muss mit verwendet werden show_timer. 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:
Datentyp: Boolesch Standardwert: false |
| Configuration.enable_ai_Code | Kennzeichnung, die angibt, ob die Generierung von KI-Code für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Configuration.enable_ai_Notes | Kennzeichnung, die angibt, ob die Generierung von KI-Notizen für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| configuration.use_ai_as_default | Kennzeichnung, die angibt, ob KI-Code automatisch als Standard-Nachbearbeitungscode für diese Konfiguration festgelegt wird. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Configuration.Show_Timer | Erforderlich, wenn die Eigenschaft „Dauer“ verwendet wird. Kennzeichnung, die angibt, ob der Timer angezeigt wird. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| external | Kennzeichnung, die angibt, ob das Interaktionssegment aus einem externen System stammt. Gültige Werte:
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:
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 Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | 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 |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge |
| Segment | Objekt mit Daten zur Interaktion und zum Nachbearbeitungssegment. Datentyp: Objekt |
| 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:
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:
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 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 |
| segment.wrap_up_configuration.allowed_codes | Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf. Datentyp: Array |
| segment.wrap_up_configuration.allowed_codes.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.allowed_codes.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.allowed_codes.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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 |
| segment.wrap_up_configuration.default_code.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.default_code.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. Datentyp: Zeichenfolge |
| segment.wrap_up_configuration.default_code.translated_description | Eine Übersetzung der Beschreibung des Nachbearbeitungscodes. Datentyp: Zeichenfolge |
| segment.wrap_up_configuration.enable_ai_code | Kennzeichnung, die angibt, ob die Generierung von KI-Code für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.enable_ai_notes | Kennzeichnung, die angibt, ob die Generierung von KI-Notizen für diese Konfiguration aktiviert ist. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.enable_codes | Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter einen Nachbearbeitungscode auswählen muss. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| segment.wrap_up_configuration.use_ai_as_default | Kennzeichnung, die angibt, ob KI-Code automatisch als Standard-Nachbearbeitungscode für diese Konfiguration festgelegt wird. Gültige Werte:
Datentyp: Boolesch |
| segment.wrap_up_configuration.use_third_party_ai | Kennzeichnung, die angibt, ob die KI-Inhaltsquelle aus einem externen System einer Drittpartei stammt. Gültige Werte:
Datentyp: Boolesch |
| Erfolg | Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte:
Datentyp: Boolesch |
| sys_id | SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment] |
cURL-Anforderung
Dieses Beispiel öffnet ein Nachbearbeitungssegment für eine Interaktion.
curl --request POST \
--url 'https://instance.servicenow.com/api/now/wrapup/segment/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user 'username:password' \
--data '{
"agent_sys_id": "123412345678567890ab90abcdefcdef",
"interaction_sys_id": "213412345678567890ab90abcdefcdef",
"external": true,
"external_segment_id": "EXT-SEG-001",
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about an incorrect charge on their invoice.",
"configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [{"code": "Billing Issue"}, {"code": "Store Issue"}],
"default_code": "Billing Issue"
}
}'
--user 'username':'password'
Antworttext.
{
"success": true,
"message": "Wrap-up segment created successfully.",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"external": true,
"interaction": "213412345678567890ab90abcdefcdef",
"state": "open",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"wrap_up_configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [...],
"default_code": {...}
}
}
}
cURL-Anforderung
Dieses Beispiel öffnet ein Nachbearbeitungssegment, das für KI-Empfehlungen konfiguriert ist.
curl --request POST \
--url 'https://instance.servicenow.com/api/now/wrapup/segment/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user 'username:password' \
--data '{
"agent_sys_id": "123412345678567890ab90abcdefcdef",
"interaction_sys_id": "213412345678567890ab90abcdefcdef",
"external": true,
"external_segment_id": "EXT-SEG-001",
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about an incorrect charge on their invoice.",
"configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [{"code": "Billing Issue"}, {"code": "Store Issue"}],
"default_code": "Billing Issue"
}
}'
Antworttext.
{
"success": true,
"message": "Wrap-up segment created successfully.",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"external": true,
"interaction": "213412345678567890ab90abcdefcdef",
"state": "open",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"wrap_up_configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [...],
"default_code": {...}
}
}
}
Nachbearbeitung – 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
| 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 |
| Name | Beschreibung |
|---|---|
| Agent_sys_ID | SYS_ID des Agenten, der der Interaktion zugewiesen ist. Erforderlich zusammen mit interaction_sys_idWenn keine der beiden segment_sys_idNoch nicht external_segment_idSind angegeben. 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, wenn 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_idSind angegeben. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion] |
| Segment_sys_ID | SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment] |
| Name | Beschreibung |
|---|---|
| Confirmed_on | Enddatum und -Uhrzeit des Nachbearbeitungszeitraums gemäß dem externen System. Datentyp: Zeichenfolge |
| Notizen | Zusätzliche Notizen, die der Nachbearbeitung vom Service Desk-Mitarbeiter hinzugefügt wurden. 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: Interaktionsbearbeitungscode [interaction_wrap_up_code] Feld: Code |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | 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 |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge |
| Segment | Objekt mit Daten zur Interaktion und zum Nachbearbeitungssegment. Datentyp: Objekt |
| Segment.Agent | SYS_ID des Agenten, 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:
Datentyp: Boolesch |
| Segment.Code | Objekt, das den vom Service Desk-Mitarbeiter ausgewählten Nachbearbeitungscode enthält. Datentyp: Objekt |
| segment.code.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| Segment.Code.sys_ID | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| Segment.Code.translated_Code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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:
Datentyp: Boolesch Standardwert: false |
| segment.interaction | SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion] |
| segment.notes | Zusätzliche Notizen, die der Nachbearbeitung vom Service Desk-Mitarbeiter hinzugefügt wurden. 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:
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 |
| segment.wrap_up_configuration.allowed_codes | Array von Objekten, die jeweils einen Nachbearbeitungscode darstellen, den der Service Desk-Mitarbeiter verwenden darf. Datentyp: Array |
| segment.wrap_up_configuration.allowed_codes.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.allowed_codes.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.allowed_codes.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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 |
| segment.wrap_up_configuration.default_code.active | Kennzeichnung, die angibt, ob der Nachbearbeitungscode aktiv ist. Gültige Werte:
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:
Datentyp: Boolesch |
| segment.wrap_up_configuration.default_code.sys_id | SYS_ID des Nachbearbeitungscodes. Datentyp: Zeichenfolge Tabelle: Interaktionsbearbeitungscode [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Eine Übersetzung der Bezeichnung für den Nachbearbeitungscode. 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:
Datentyp: Boolesch Standardwert: false |
| Erfolg | Kennzeichnung, die angibt, ob die API-Anforderung erfolgreich verarbeitet wurde. Gültige Werte:
Datentyp: Boolesch |
| sys_id | SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment] |
cURL-Anforderung
Dieses Beispiel aktualisiert und schließt ein Nachbearbeitungssegment für eine Interaktion.
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
}
}
Nachbearbeitung – PUT /now/wrapup/Segment/Update/ai
Aktualisiert ein vorhandenes offenes Nachbearbeitungssegment mit KI-empfohlenen Nachbearbeitungscodes und Notizen.
Dieser Endpunkt ist für externe CCaaS-Systeme vorgesehen, die KI-Inhalte unabhängig generieren und in übertragen ServiceNow Plattform nach Segmenterstellung. Die use_third_party_aiEigenschaft muss sein Wahr In der Nachbearbeitungskonfiguration.
Wenn enable_ai_codeOder enable_ai_notesIst Falsch In der Konfiguration werden die entsprechenden KI-Felder gespeichert, auch wenn sie in der Anforderungsnutzlast enthalten sind. Die ai_code_defined_atUnd ai_notes_defined_atZeitstempel werden automatisch zum Zeitpunkt der Speicherung festgelegt.
- KI-Abschlussempfehlungen
-
KI-Nachbearbeitungsempfehlungen können aus zwei Quellen stammen:
- Intern ( Now Assist): Wann use_third_party_aiIst „falsch“, wird nach der Segmenterstellung automatisch eine Business-Regel ausgelöst, um die CSM-API aufzurufen und auszufüllen ai_wrap_up_codeUnd ai_notes.
- Extern (Drittpartei/CCaaS): Wann use_third_party_aiIst „wahr“, sendet das externe System KI-Daten über die neue BEREITSTELLUNG /api/now/wrapup/Segment/Update/ai Endpunkt.
- Anwendungsfälle
-
- Reduzieren Sie die Bearbeitungszeit von Service Desk-Mitarbeitern, indem Sie Nachbearbeitungscodes und Notizen mit KI-Vorschlägen bereitstellen.
- Aktivieren Sie CCaaS-Plattformen, um KI-generierte Inhalte in zu veröffentlichen ServiceNow AI Platform Nachdem eine Interaktion endet.
- Geben Sie Vorgesetzten bereinigte, konsistentere Nachbearbeitungsdaten für Berichterstellung und Analytics an.
- Endpunkt-Anrufreihenfolge für einen KI-gestützten Nachbearbeitungs-Flow
-
- VERÖFFENTLICHEN /api/now/wrapup/Segment/create – Öffnen Sie ein Segment oder übergeben Sie es ai_wrap_up_code/ ai_notesUnd KI-Konfigurationskennzeichnungen.
- PLATZIEREN /api/now/wrapup/Segment/Update/ai – (Nur externe KI) KI-Empfehlungen auf das offene Segment übertragen.
- PLATZIEREN /api/now/wrapup/Segment/Update – Service Desk-Mitarbeiter schließt das Segment ab und schließt es.
- ABRUFEN /api/now/wrapup/Segment/{Segment_ID} – Segment einschließlich gespeicherter KI-Felder abrufen.
URL-Format
Versionierte URL: /api/now/{api_Version}/wrapup/Segment/Update/ai
Standard-URL: /api/now/wrapup/Segment/Update/ai
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Agent_sys_ID | SYS_ID des Agenten, der der Interaktion zugewiesen ist. Erforderlich mit interaction_sys_idWenn keine der beiden segment_sys_idNoch nicht external_segment_idSind angegeben. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| ai_wrap_up_code | VON KI empfohlene Nachbearbeitungscodebezeichnung. Wird nur gespeichert, wenn enable_ai_codeEigenschaft ist Wahr In der Konfiguration.Nachbearbeitung: VERÖFFENTLICHEN SIE /now/wrapup/Segment/create Datentyp: Zeichenfolge |
| KI_Notes | KI-generierte Notizen. . Wird nur gespeichert, wenn „enable_ai_Notes“ in der Konfiguration auf „wahr“ festgelegt ist.Nachbearbeitung: VERÖFFENTLICHEN SIE /now/wrapup/Segment/create Max. Länge: 4000 Zeichen Datentyp: Zeichenfolge |
| Interaction_sys_ID | SYS_ID der Interaktion. Erforderlich mit agent_sys_idWenn keine der beiden segment_sys_idNoch nicht external_segment_idSind angegeben. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion] |
| Segment_sys_ID | SYS_ID des Nachbearbeitungssegments. Datentyp: Zeichenfolge Tabelle: Interaktionsnachbearbeitungssegment [interaction_wrap_up_segment] |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | 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 |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Nachricht, die das Ergebnis der API-Anforderung beschreibt. Datentyp: Zeichenfolge |
| Segment | Objekt mit Daten zur Interaktion und zum Nachbearbeitungssegment. Datentyp: Objekt |
| Segment.Agent | SYS_ID des Agenten, der der Interaktion zugewiesen ist. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| segment.ai_code_defined_at | Zeitstempel, wann KI-Code gespeichert wurde. Format: UNIX-Epoche Millisekunden (z. B. „1752252703000“) Datentyp: Zeichenfolge |
| Segment.ai_Notes | KI-generierte Notizen, die im Segment gespeichert sind. Datentyp: Zeichenfolge |
| segment.ai_notes_defined_at | Zeitstempel, zu dem KI-Notizen gespeichert wurden. Format: UNIX-Epoche Millisekunden Datentyp: Zeichenfolge |
| segment.ai_wrap_up_code | KI-empfohlener Code, der im Segment gespeichert ist. Datentyp: Zeichenfolge |
| segment.interaction | SYS_ID der Interaktion. Datentyp: Zeichenfolge Tabelle: Interaktion [Interaktion] |
| Segment.sys_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:
Datentyp: Boolesch |
cURL-Anforderung
Dieses Beispiel aktualisiert und schließt ein Nachbearbeitungssegment für eine Interaktion.
curl --request PUT \
--url 'https://instance.servicenow.com/api/now/wrapup/segment/update/ai' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user 'username:password' \
--data '{
"segment_sys_id": "abcd1234abcd1234abcd1234abcd1234",
"agent_sys_id": "123412345678567890ab90abcdefcdef",
"interaction_sys_id": "213412345678567890ab90abcdefcdef",
"ai_wrap_up_code": "Plan Update",
"ai_notes": "Customer requested an upgrade to the Premium plan."
}' \
--user 'username':'password'
Antworttext.
{
"success": true,
"message": "AI wrap-up data updated successfully.",
"segment": {
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"agent": "123412345678567890ab90abcdefcdef",
"interaction": "213412345678567890ab90abcdefcdef",
"ai_wrap_up_code": "Plan Update",
"ai_notes": "Customer requested an upgrade to the Premium plan.",
"ai_code_defined_at": "1752252703000",
"ai_notes_defined_at": "1752252703000"
}
}