Omichannel-Rückruf-API

  • Freigeben Version: Zurich
  • Aktualisiert 1. August 2025
  • 14 Minuten Lesedauer

    • Die Omni-Channel-Rückruf Die API bietet Methoden zum Erstellen oder Aktualisieren einer Rückrufanforderung und zum Abrufen zugehöriger Metadaten von einem CCaaS-Anbieter (Contact Center as a Service).

    Die Omni-Channel-Rückruf Mit der API können Service Desk-Mitarbeiter Anwender programmgesteuert zurückrufen, anstatt in der Warteschlange auf einen verfügbaren Service Desk-Mitarbeiter zu warten. Beispielsweise können Service Desk-Mitarbeiter die Rückruffunktion verwenden, um Anwender zurückzurufen, wenn die Wartezeit des Service Desk-Mitarbeiters lang ist oder wenn keine Service Desk-Mitarbeiter verfügbar sind. Mit dieser API können Sie die folgenden Aktionen ausführen:
    • Erstellen Sie eine neue, sofortige Rückrufanforderung, oder planen Sie eine neue Anforderung.
    • Erstellen Sie eine erste Interaktion und nachfolgende Wiederholungsinteraktionen.
    • Aktualisieren Sie einen vorhandenen Rückruf.

    Diese API gehört zum Namespace sn_omni_Callback und erfordert den Administrator mit der Rückruf-API [sn_omni_callback.callback_api] Rolle.

    Weitere Informationen zu finden Omni-Channel-Rückruf Anwendung als ServiceNow KI-Plattformfähigkeit, siehe Omnichannel Callback.

    Omni-Channel-Rückruf: VERÖFFENTLICHEN SIE /api/sn_omni_Callback/Callback/attempt

    Initiiert eine Interaktion für einen vorhandenen Rückruf, einschließlich Wiederholungsversuche.

    URL-Format

    Standard-URL: /api/sn_omni_callback/callback/attempt

    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
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    CallbackID Erforderlich. SYS_ID oder external_ID des Rückrufs.

    Tabelle: Rückruf [sys_cs_Callback]

    Datentyp: Zeichenfolge
    InteractionDetails Optional. Details zur Interaktion. Vorgesehen für sofortige Rückruftypen, damit Interaktionsdetails direkt an den Service Desk-Mitarbeiter weitergeleitet werden, ohne zu warten.

    Alle Interaktionsdetails werden in der Nutzlast des übergeben Sprachinteraktionsressource – POST /cs/Voice-Interaktionen.

    Datentyp: Objekt

    "interactionDetails": {
  "callerPhoneNumber": "String",
  "clientSessionId": "String",
  "userId": "String"
}
    interactionDetails.callerPhoneNumber Rückruftelefonnummer des Anrufers. Dies ist die Nummer, die der Service Desk-Mitarbeiter verwendet, um den Anrufer zu erreichen, falls der Anruf abbricht.

    Datentyp: Zeichenfolge

    Format: E.164-Standard konform

    Standard: Keine
    InteractionDetails.clientSessionId Eindeutiger Bezeichner eines Datensatzes in einem externen System, der zum Nachverfolgen dieses Telefonanrufs systemübergreifend verwendet wird, wodurch die Integration zwischen ServiceNow und Drittpartei-Plattformen (z. B. CCaaS-Anbieter) ermöglicht wird.

    Datentyp: Zeichenfolge

    Format: Normalerweise eine UUID oder ein eindeutiges Sitzungstoken, das vom externen System generiert wird

    Standard: Keine
    interactionDetails.userId SYS_ID des Anwenders, der zurückgerufen werden soll.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge

    Header

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

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

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

    Standard: application/json

    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.
    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
    Fehler Nachricht mit Details zu den Fehlern bei der Rückruferstellung, z. B. fehlende erforderliche Anforderungs-IDs.

    Datentyp: Array von Zeichenfolgen

    "errors": ["String", "String"]
    Nachrichten Nachricht mit Details zum Erfolg der Rückruferstellung.

    Datentyp: Array von Zeichenfolgen

    "messages": ["String", "String"]
    Ergebnis Ergebnis der Anforderung.

    Datentyp: Objekt

    "result": {
  "status": "String",
  "response": {Object},
  "errors": [Array],
  "messages": [Array]
}
    Ergebnis.Antwort Objekt mit Rückruf- und Interaktions-IDs der Rückrufanforderung.

    Datentyp: Objekt

    "response": {
  "callback_created": Boolean
  "callback_id": "String",
  "interaction_id": "String"
}
    result.response.interaction_id SYS_ID der neu erstellten Interaktion.

    Tabelle: Interaktion [Interaktion]

    Datentyp: Zeichenfolge
    Ergebnis.Status Erfolgs- oder Fehlerstatus der Anforderung.
    Gültige Werte:
    • Erfolg
    • Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt eine Anforderung NACH dem Versuch mit Details zur anfänglichen Interaktion und den nachfolgenden Wiederholungsinteraktionen.

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/attempt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "callbackId": "<ID#>",
  "interactionDetails": {
    "clientSessionId": "<ID#>",
    "userId": "<ID#>",
    "callerPhoneNumber": "+112345678901"
  }
}

    Antworttext, wenn eine gültige Callback_ID angegeben wird und eine neue Interaktion für den Rückruf erfolgreich erstellt wurde.

    {
  "result": {
    "status": "success",
    "response": {
      "interaction_id": "<Interaction ID#>"
    }
  }
}

    Antworttext, wenn in der Anforderung eine ungültige Callback_ID angegeben wurde.

    {
  "result": {
    "status": "failure",
    "response": {
      "interactionId": null
    },
    "errors": [
      "Callback not found for callback ID: <ID#>"
    ]
  }
}

    Antworttext, wenn die Interaktion für den angegebenen Rückruf bereits vorhanden ist (Nachricht gibt Details zur vorhandenen Interaktion zurück):

    {
  "result": {
    "status": "success",
    "response": {
      "interaction_id": "<Interaction ID#>"
    },
    "messages": [
      "Active Interaction <Interaction ID#> already exists for callback <ID#>"
    ]
  }
}

    Omichannel-Rückruf – POST /api/sn_omni_Callback/Callback/create

    Initiiert eine neue sofortige oder geplante Rückrufanforderung basierend auf den Details, die Sie im Anforderungstext angeben. Für sofortige Rückrufe erstellt diese API sowohl den Rückruf als auch die Interaktion. Erstellt für geplante Rückrufe den Rückruf und einen Termin.

    URL-Format

    Standard-URL: /api/sn_omni_Callback/Callback/create

    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
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    CallbackContext Objekt mit den Kontextdetails zur Rückrufanforderung.

    Tabelle: Rückrufkontext [sys_cs_Callback_context]

    Datentyp: Objekt

    "callbackContext": {
  "customer_timezone": "String",
  "ivr_path": "String",
  "source_channel": "String",
  "queue": "String"
}
    CallbackContext.ivr_path Der IVR-Pfad (Interactive Voice Response), dem ein Kunde folgt, bevor er an einen Human Agent übertragen wird.

    Enthält normalerweise eine Liste von Warteschlangen oder Menüoptionen, durch die der Kunde im IVR-System navigiert hat. Diese Zeichenfolge wird vom Contact Center as a Service (CCaaS) übergeben. Beispiel: „ivr_path“: „Technischer Support > Account-Management“

    Datentyp: Zeichenfolge
    CallbackContext.Queue Nummernzuweisungen in der Warteschlange.

    Datentyp: Zeichenfolge
    CallbackDetails Objekt mit den Details zur Rückrufanforderung.

    Tabelle: Rückruf [sys_cs_Callback]

    Datentyp: Objekt

    "callbackDetails": {
  "appointment": "String",
  "channel_to_callback": "String",
  "description": "String",
  "end_time": "String",
  "expire_time": "String",
  "messaging_channel": String",
  "reason_type": "String"
  "scheduled_start_time": "String",
  "short_description": "String",
  "user_document": "String",
  "user_table": "String"
}
    CallbackDetails.Termin SYS_ID des Termins. Gilt nur für Geplant Rückruftyp.

    Tabelle: Terminbuchung [sn_apptmnt_booking_appointment_booking]

    Datentyp: Zeichenfolge
    callbackDetails.channel_to_callback Ziel-Messaging-Kanal, über den der Rückruf weitergeleitet werden soll.

    Tabelle: Messaging-Kanal [sys_cs_Channel], Feld: sys_ID

    Datentyp: Zeichenfolge
    callbackDetails.description Vollständige Beschreibung, die den Grund für den Rückruf bei Bedarf beschreibt.

    Datentyp: Zeichenfolge
    CallbackDetails.end_time Datums- und Uhrzeitwert zum Anhalten des Rückrufversuchs. Gilt nur für Geplant Rückruftyp.

    Format: Glide_date_time-Wert, z. B. jjjj-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    CallbackDetails.expire_time Datum und Uhrzeit für das Schließen der Rückrufanforderung.

    Format: Glide_date_time-Wert, z. B. jjjj-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    CallbackDetails.Messaging_Channel Quelle des Rückrufs. Gibt die Client-Schnittstelle an, die die Rückrufanforderung initiiert hat, z. B. einen Webclient, eine mobile App oder einen eingebetteten Messenger.

    Tabelle: Messaging-Kanal [sys_cs_Channel], Feld: sys_ID

    Datentyp: Zeichenfolge
    CallbackDetails.reason_type Grund für die Rückrufanforderung. Hilft bei Weiterleitung, Analytics und Berichterstellung, indem der Rückruf mit einem standardisierten Grund versehen wird.
    Gültige Werte:
    • Anderes Problem
    • Von Ihrer Implementierung definierte anwenderdefinierte Werte. Beispiel: „Abrechnungsanfrage“ , „Technischer Support“

    Tabelle: Rückruf [sys_cs_callback], Feld: Reason_type

    Datentyp: Zeichenfolge
    CallbackDetails.scheduled_date_time Datums- und Uhrzeitwert zum Initiieren des Rückrufs. Gilt nur für Geplant Rückruftyp.

    Format: Glide_date_time-Wert, z. B. jjjj-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    CallbackDetails.short_description Bietet eine detaillierte Erklärung der Rückrufanforderung. Kann bestimmte Kundenbedenken, Kontext oder Notizen des Service Desk-Mitarbeiters enthalten.

    Datentyp: Zeichenfolge
    callbackDetails.user_document SYS_ID des Anwenders, der den Rückruf angefordert hat. Verwendet mit callbackDetails.user_tableUm den Anwender zu identifizieren, der den Rückruf anfordert.

    Tabelle: Anwender [sys_user], Feld: sys_ID

    Datentyp: Zeichenfolge
    callbackDetails.user_table Tabelle, in der sich der Anwenderdatensatz befindet. Verwendet mit callbackDetails.user_documentUm den Anwender zu identifizieren, der den Rückruf anfordert. Wert ist immer sys_user .

    Datentyp: Zeichenfolge
    ExternalCallbackId Externer Bezeichner für den Rückruf, der in einem Drittparteilieferanten erstellt wurde.

    Datentyp: Zeichenfolge
    eingehendeId SYS_ID des eingehenden Anrufs, der dem Rückruf zugeordnet ist. Bietet Rückverfolgbarkeit, die die Rückrufanforderung mit einem bestimmten Datensatz für eingehende Anrufe verknüpft, der von einem Drittanbieter oder einer CCaaS-Plattform stammen kann.

    Tabelle: Rückruf [sys_cs_Callback], Feld: Provider_Application_ID

    Datentyp: Zeichenfolge
    InteractionDetails Optional. Details zur Interaktion. Vorgesehen für sofortige Rückruftypen, damit Interaktionsdetails direkt an den Service Desk-Mitarbeiter weitergeleitet werden, ohne zu warten.

    Alle Interaktionsdetails werden in der Nutzlast des übergeben Sprachinteraktionsressource – POST /cs/Voice-Interaktionen.

    Datentyp: Objekt

    "interactionDetails": {
  "callerPhoneNumber": "String",
  "clientSessionId": "String",
  "userId": "String"
}
    interactionDetails.callerPhoneNumber Rückruftelefonnummer des Anrufers. Dies ist die Nummer, die der Service Desk-Mitarbeiter verwendet, um den Anrufer zu erreichen, falls der Anruf abbricht.

    Datentyp: Zeichenfolge

    Format: E.164-Standard konform

    Standard: Keine
    InteractionDetails.clientSessionId Eindeutiger Bezeichner eines Datensatzes in einem externen System, der zum Nachverfolgen dieses Telefonanrufs systemübergreifend verwendet wird, wodurch die Integration zwischen ServiceNow und Drittpartei-Plattformen (z. B. CCaaS-Anbieter) ermöglicht wird.

    Datentyp: Zeichenfolge

    Format: Normalerweise eine UUID oder ein eindeutiges Sitzungstoken, das vom externen System generiert wird

    Standard: Keine
    interactionDetails.userId SYS_ID des Anwenders, der zurückgerufen werden soll.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    isExternal Kennzeichnung, die angibt, ob der Rückruf extern ist und bei einem anderen Drittparteilieferanten angefordert wurde.
    Gültige Werte:
    • Wahr: Rückruf ist extern.
    • Falsch: Rückruf ist nicht extern.

    Standardwert: false
    type Erforderlich. Typ des Rückrufs.
    Gültige Werte:
    • Sofort : Die Rückrufinteraktion wird sofort erstellt.
    • Geplant : Die Rückrufinteraktion wird erstellt und für einen späteren, vom Kunden ausgewählten Zeitpunkt geplant.

    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 : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

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

    Standard: application/json

    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.
    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 Ergebnis der Anforderung.

    Datentyp: Objekt

    "result": {
  "status": "String",
  "response": {Object},
  "errors": [Array],
  "messages": [Array]
}
    Ergebnis.Fehler Nachricht mit Details zu den Fehlern bei der Rückruferstellung, z. B. fehlende erforderliche Anforderungs-IDs.

    Datentyp: Array von Zeichenfolgen

    "errors": ["String", "String"]
    Ergebnis.Nachrichten Nachricht mit Details zum Erfolg der Rückruferstellung.

    Datentyp: Array von Zeichenfolgen

    "messages": ["String", "String"]
    Ergebnis.Antwort Objekt mit Rückruf- und Interaktions-IDs der Rückrufanforderung.

    Datentyp: Objekt

    "response": {
  "callback_created": Boolean
  "callback_id": "String",
  "interaction_id": "String"
}
    result.response.callback_created

    Kennzeichnung, die angibt, ob die neue Rückrufanforderung erstellt wurde oder nicht.

    Mögliche Werte:
    • Wahr: Rückruf wurde erfolgreich erstellt.
    • Falsch: Rückruf wurde nicht erstellt. Beispielsweise ist der Rückruf mit der angegebenen Callback_ID bereits vorhanden

    Datentyp: Boolesch
    result.response.callback_id SYS_ID des neuen Rückrufs, falls zutreffend.

    Tabelle: Rückruf [sys_cs_Callback]

    Datentyp: Zeichenfolge
    result.response.interaction_id SYS_ID der neu erstellten Interaktion.

    Tabelle: Interaktion [Interaktion]

    Datentyp: Zeichenfolge
    Ergebnis.Status Erfolgs- oder Fehlerstatus der Anforderung.
    Gültige Werte:
    • Erfolg
    • Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel erstellt eine einfache Rückrufanforderung gemäß den Details, die der Service Desk-Mitarbeiter im Anforderungstext bereitstellt.

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/create' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "type": "immediate",
  "callbackDetails": {
    "appointment": "68cc0a5a9314521060320dd548373cbd",
    "description": "Customer reported issue with order #12345",
    "short_description": "Order issue",
    "reason_type": "product_issue",
    "expire_time": "2025-09-01 17:00",
    "messaging_channel": "web_channel_sys_id",
    "channel_to_callback": "genesys_channel_sys_id",
    "scheduled_start_time: "2025-09-01 1:00",
    "end_time": "2025-09-01 17:00",
    "user_document": "abel.tuter",
    "user_table": "sys_user"
},
  },
  "callbackContext": {
    "queue": "21 value changed via api",
    "ivr_path": "21 some-ivr-path changed via api"
  },
  "inboundId": "ServiceNowVoice",
  "isExternal": true,
  "externalCallbackId": "new-external-id",
  "interactionDetails": {
    "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z",
    "userId": "32423424",
    "callerPhoneNumber": "+14089178877"
  }
}

    Der Antworttext gibt eine Erfolgsantwort mit Rückruf- und Interaktions-IDs für die neu erstellte Rückrufanforderung zurück.

    {
  "status": "success",
  "response": {
    "callback_id": "a16ead53fff0621088c6ffffffffffce",
    "interaction_id": "696e6d57fff0621088c6ffffffffff7d"
  }
}

    Antworttext, wenn keine Interaktionsdetails angegeben wurden:

    {
  "status": "success",
  "response": {
    "callback_created": true,
    "callback_id": "7df2059ffffc221088c6ffffffffff0c"
  }
}

    Antworttext, wenn die Rückruf-ID bereits vorhanden ist, aber neue Interaktionsdetails angegeben wurden:

    {
  "result": {
    "status": "success",
    "response": {
      "interaction_id": "84054fff53786210011eddeeff7b12d6",
      "callback_id": "8b43c3fb53786210011eddeeff7b12a6",
      “callback_created”: false
    },
    "messages": [
      "Successfully updated the callback 8b43c3fb53786210011eddeeff7b12a6",
      "Successfully created the interaction 84054fff53786210011eddeeff7b12d6"
    ]
  }
}

    Antworttext, wenn die Rückruf-ID bereits vorhanden ist, aber keine neuen Interaktionsdetails angegeben wurden:

    {
  "result": {
    "status": "success",
    "response": {
      "callback_id": "8b43c3fb53786210011eddeeff7b12a6"
    },
    "messages": [
      "Successfully updated the callback 8b43c3fb53786210011eddeeff7b12a6"
    ]
  }
}

    Antworttext, wenn Pflichtfelder in der Anforderung fehlen:

    {
  "result": {
    "status": "failure",
    "response": {
      "callbackId": null
    },
    "errors": [
      "Parameter 'type' is required in request"
    ]
  }
}

    Omni-Channel-Rückruf: PATCH /api/sn_omni_Callback/Callback/Update

    Aktualisiert einen vorhandenen Rückruf gemäß den in der Anforderung angegebenen Details.

    Geben Sie nur Anforderungsparameter im Anforderungstext an, den Sie aktualisieren möchten.

    URL-Format

    Standard-URL: /api/sn_omni_Callback/Callback/Update

    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
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    CallbackContext Objekt mit den Kontextdetails zur Rückrufanforderung.

    Tabelle: Rückrufkontext [sys_cs_Callback_context]

    Datentyp: Objekt

    "callbackContext": {
  "customer_timezone": "String",
  "ivr_path": "String",
  "source_channel": "String",
  "queue": "String"
}
    CallbackContext.ivr_path Der IVR-Pfad (Interactive Voice Response), dem ein Kunde folgt, bevor er an einen Human Agent übertragen wird.

    Enthält normalerweise eine Liste von Warteschlangen oder Menüoptionen, durch die der Kunde im IVR-System navigiert hat. Diese Zeichenfolge wird vom Contact Center as a Service (CCaaS) übergeben. Beispiel: „ivr_path“: „Technischer Support > Account-Management“

    Datentyp: Zeichenfolge
    CallbackContext.Queue Nummernzuweisungen in der Warteschlange.

    Datentyp: Zeichenfolge
    CallbackDetails Objekt mit den Details zur Rückrufanforderung.

    Tabelle: Rückruf [sys_cs_Callback]

    Datentyp: Objekt

    "callbackDetails": {
  "appointment": "String",
  "channel_to_callback": "String",
  "description": "String",
  "end_time": "String",
  "expire_time": "String",
  "messaging_channel": String",
  "reason_type": "String"
  "scheduled_start_time": "String",
  "short_description": "String",
  "user_document": "String",
  "user_table": "String"
}
    CallbackDetails.Termin SYS_ID des Termins. Gilt nur für Geplant Rückruftyp.

    Tabelle: Terminbuchung [sn_apptmnt_booking_appointment_booking]

    Datentyp: Zeichenfolge
    callbackDetails.channel_to_callback Ziel-Messaging-Kanal, über den der Rückruf weitergeleitet werden soll.

    Tabelle: Messaging-Kanal [sys_cs_Channel], Feld: sys_ID

    Datentyp: Zeichenfolge
    callbackDetails.description Vollständige Beschreibung, die den Grund für den Rückruf bei Bedarf beschreibt.

    Datentyp: Zeichenfolge
    CallbackDetails.end_time Datums- und Uhrzeitwert zum Anhalten des Rückrufversuchs. Gilt nur für Geplant Rückruftyp.

    Format: Glide_date_time-Wert, z. B. jjjj-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    CallbackDetails.expire_time Datum und Uhrzeit für das Schließen der Rückrufanforderung.

    Format: Glide_date_time-Wert, z. B. jjjj-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    CallbackDetails.Messaging_Channel Quelle des Rückrufs. Gibt die Client-Schnittstelle an, die die Rückrufanforderung initiiert hat, z. B. einen Webclient, eine mobile App oder einen eingebetteten Messenger.

    Tabelle: Messaging-Kanal [sys_cs_Channel], Feld: sys_ID

    Datentyp: Zeichenfolge
    CallbackDetails.reason_type Grund für die Rückrufanforderung. Hilft bei Weiterleitung, Analytics und Berichterstellung, indem der Rückruf mit einem standardisierten Grund versehen wird.
    Gültige Werte:
    • Anderes Problem
    • Von Ihrer Implementierung definierte anwenderdefinierte Werte. Beispiel: „Abrechnungsanfrage“ , „Technischer Support“

    Tabelle: Rückruf [sys_cs_callback], Feld: Reason_type

    Datentyp: Zeichenfolge
    CallbackDetails.scheduled_date_time Datums- und Uhrzeitwert zum Initiieren des Rückrufs. Gilt nur für Geplant Rückruftyp.

    Format: Glide_date_time-Wert, z. B. jjjj-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    CallbackDetails.short_description Bietet eine detaillierte Erklärung der Rückrufanforderung. Kann bestimmte Kundenbedenken, Kontext oder Notizen des Service Desk-Mitarbeiters enthalten.

    Datentyp: Zeichenfolge
    callbackDetails.user_document SYS_ID des Anwenders, der den Rückruf angefordert hat. Verwendet mit callbackDetails.user_tableUm den Anwender zu identifizieren, der den Rückruf anfordert.

    Tabelle: Anwender [sys_user], Feld: sys_ID

    Datentyp: Zeichenfolge
    callbackDetails.user_table Tabelle, in der sich der Anwenderdatensatz befindet. Verwendet mit callbackDetails.user_documentUm den Anwender zu identifizieren, der den Rückruf anfordert. Wert ist immer sys_user .

    Datentyp: Zeichenfolge
    CallbackID Erforderlich. SYS_ID oder external_ID des Rückrufs.

    Tabelle: Rückruf [sys_cs_Callback]

    Datentyp: Zeichenfolge
    eingehendeId SYS_ID des eingehenden Anrufs, der dem Rückruf zugeordnet ist. Bietet Rückverfolgbarkeit, die die Rückrufanforderung mit einem bestimmten Datensatz für eingehende Anrufe verknüpft, der von einem Drittanbieter oder einer CCaaS-Plattform stammen kann.

    Tabelle: Rückruf [sys_cs_Callback], Feld: Provider_Application_ID

    Datentyp: Zeichenfolge
    phoneNumber Telefonnummer des Anrufers.

    Datentyp: Zahlenzeichenfolge

    Format: E.164-Standard konform

    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 : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

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

    Standard: application/json

    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.
    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
    Fehler Nachricht mit Details zu den Fehlern bei der Rückruferstellung, z. B. fehlende erforderliche Anforderungs-IDs.

    Datentyp: Array von Zeichenfolgen

    "errors": ["String", "String"]
    Nachrichten Nachricht mit Details zum Erfolg der Rückruferstellung.

    Datentyp: Array von Zeichenfolgen

    "messages": ["String", "String"]
    Ergebnis Ergebnis der Anforderung.

    Datentyp: Objekt

    "result": {
  "status": "String",
  "response": {Object},
  "errors": [Array],
  "messages": [Array]
}
    Ergebnis.Antwort Objekt mit Rückruf- und Interaktions-IDs der Rückrufanforderung.

    Datentyp: Objekt

    "response": {
  "callback_created": Boolean
  "callback_id": "String",
  "interaction_id": "String"
}
    result.response.callback_created

    Kennzeichnung, die angibt, ob die neue Rückrufanforderung erstellt wurde oder nicht.

    Mögliche Werte:
    • Wahr: Rückruf wurde erfolgreich erstellt.
    • Falsch: Rückruf wurde nicht erstellt. Beispielsweise ist der Rückruf mit der angegebenen Callback_ID bereits vorhanden

    Datentyp: Boolesch
    result.response.callback_id SYS_ID des neuen Rückrufs, falls zutreffend.

    Tabelle: Rückruf [sys_cs_Callback]

    Datentyp: Zeichenfolge
    result.response.interaction_id SYS_ID der neu erstellten Interaktion.

    Tabelle: Interaktion [Interaktion]

    Datentyp: Zeichenfolge
    Ergebnis.Status Erfolgs- oder Fehlerstatus der Anforderung.
    Gültige Werte:
    • Erfolg
    • Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel werden einige Rückrufdetails in der zugehörigen Rückrufanforderung aktualisiert.

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/update' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "callbackDetails": {
    "appointment": "68cc0a5a9314521060320dd548373cbd",
    "description": "Customer reported issue with order #12345",
    "short_description": "Order issue",
    "reason_type": "product_issue",
    "expire_time": "2025-09-01 17:00",
    "messaging_channel": "web_channel_sys_id",
    "channel_to_callback": "genesys_channel_sys_id",
    "scheduled_start_time: "2025-09-01 1:00",
    "end_time": "2025-09-01 17:00",
    "user_document": "abel.tuter",
    "user_table": "sys_user"
},
  "callbackContext": {
    "queue": "5 value changed via api",
    "ivr_path": "5 some-ivr-path changed via api"
  },
  "inboundId": "AmazonConnect",
  "phoneNumber": "+14089178877",
  "callbackId": "a16ead53fff0621088c6ffffffffffce"
}

    Antwort einer erfolgreichen Aktualisierung der gültigen, vorhandenen Rückruf-ID.

    {
  "result": {
    "status": "success",
    "response": {
      "callback_id": "952f763b53786210011eddeeff7b1297"
    },
    "messages": [
      "Successfully updated the callback 952f763b53786210011eddeeff7b1297"
    ]
  }
}
    Antwort, wenn in der Anforderung eine ungültige Rückruf-ID angegeben wird:
    
  "result": {
    "status": "failure",
    "response": {
      "callbackId": null
    },
    "errors": [
      "Callback not found for callback ID: 952f763b53786210011eddeef7b1297"
    ]
  }
}
    Antwort, wenn eine Rückruf-ID in der Anforderung fehlt:
    
  "result": {
    "status": "failure",
    "response": {
      "callbackId": null
    },
    "errors": [
      "Parameter 'callbackId' is required in request"
    ]
  }
}