Virtual Agent-API Funktionen, die im Store-Release 3,0.x verfügbar sind

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 5 Minuten Lesedauer

    • Virtual Agent-APIVersion 3,0.x bietet Zugriff auf mehr der gleichen Funktionen, die in verfügbar sind Virtual AgentUnd Mitarbeiterchat, Einschließlich der Möglichkeit, Dateien aus einer privaten URL hochzuladen, und Verbesserungen beim synchronen Handshake.

    Beendet „Verworfen“ Virtual AgentKonversationen

    Wenn eine Konversation aufgrund eines Fehlers unvollständig ist, Virtual AgentKann den primären Bot bitten, die Kontrolle zu übernehmen. Wenn takeControlKennzeichnung ist true, Virtual Agent(Als sekundärer Bot) schließt die Konversation automatisch. Wenn der primäre Bot eine Konversation starten möchte, kann er die folgende Aktionsnachricht senden: „hallo“/START_CONVERSATION .

    Sie können den primären Bot in den folgenden Situationen bitten, die Kontrolle zu übernehmen:
    • Inaktivitätszeitüberschreitung: Interaktionsstatus ist Als Verworfen Geschlossen . Statusgrund ist Keine Aktivität .
    • Technische Probleme: Interaktionsstatus ist Als Verworfen Geschlossen . Statusgrund ist Bot-Probleme .
    • Ungültige Anwendereingabe: Interaktionsstatus ist Als Verworfen Geschlossen . Statusgrund ist Ungültige Anwendereingabe .

    Um anzufordern, dass der primäre Bot die Kontrolle übernimmt, senden Sie takeControlKennzeichnen Sie im Textkörper der Nutzlast für den primären Bot mit einem Wert von true.

    Beispielnutzlast der Nachricht:   
    {​ 
   "requestId": "xxxx-xxxx-xxxx-xxxx",
   "clientSessionId": "xxx-xxx-xxx-xxx",
   "message": {
       "text":"invalid3",
       "typed":true
       }
   "body":[{
       "uiType":"OutputText",
       "group":"DefaultText",
       "value":"Sorry, I didn't get that. Could you help me by answering this?"
       },
       {
       "uiType":"Boolean",
       "group":"DefaultPicker",
       "required":true,
       "nluTextEnabled": false,
       "label":"Choose a value",
       "options":[
          {"label":"Yes"},
          {"label":"No"}
          ]
       }],
    "takeControl":true,
    "score":0
}

    Verbesserte Fehler beim Themenwechsel und Fehlerbehebung

    Der Themenwechsel kann aus einem der folgenden Gründe fehlschlagen:
    • Die Anforderung enthält sowohl den Themennamen als auch die Themen-ID (Stichwort-Thema-Discovery) oder den Namen der Themenabsicht und die Themenabsicht-ID (NLU-Themen-Discovery). Geben Sie eine oder die andere an.
    • Die Anforderung enthält einen ungültigen Thema- oder Absichtsnamen oder eine ungültige ID.
    • Der Thema-/Absichtsname oder die ID ist gültig, aber Virtual AgentKann nicht ausgeführt werden, da es sich um ein inaktives Thema handelt. Beispiel: Wenn sich der Name oder die ID auf einen Themenblock oder ein anwenderdefiniertes Steuerungs-Asset bezieht.
    • Das angeforderte Thema wird bereits ausgeführt.
    • Das angeforderte Thema ist gültig, aber eine Sicherheitsbedingung verhindert den Zugriff. Beispielsweise darf das Thema möglicherweise nicht im Kanal ausgeführt werden, oder es kann eine andere Zugriffssteuerungsbedingung gelten.
    Wenn der Themenwechsel fehlschlägt, Virtual Agent-APIReagiert auf folgende Arten, unabhängig davon, ob Sie sie synchron oder asynchron verwenden:
    • Wenn der Themenwechsel fehlschlägt, wird die Konversation mit einer Nachricht geschlossen, die besagt, dass die Konversation nicht fortgesetzt werden kann. Die Konversation verbleibt nicht mehr im offenen Status.
    • Die vorherige Anforderung wird als verarbeitet markiert, damit eine neue Anforderung gestellt werden kann, ohne auf eine Zeitüberschreitung zu warten.
    • Der Grund für den Fehler wird in der Systemprotokolltabelle protokolliert (Automated Test Framework > Systemprotokolle > Fehler) an.

    Verbesserungen beim synchronen Handshake

    Ab Version 3,0.x, Virtual Agent-APIKann synchron an einen Servicemitarbeiter übertragen werden. Wenn ein Anwender oder Service Desk-Mitarbeiter eine Konversation beendet, wird die Übertragung zurück an Virtual AgentWird auch synchron durchgeführt. Einige Systemnachrichten und Wartezeitnachrichten werden ebenfalls synchron gesendet.

    Beachten Sie die folgenden Richtlinien, um die synchrone Übertragung an einen Servicemitarbeiter zu verwenden:
    • Konfigurieren Sie Virtual AgentAntwortendpunkt. MitarbeiterchatNachrichten werden an den von Ihnen angegebenen Endpunkt zugestellt.
    • Sie müssen Benachrichtigungen für die Instanz manuell deaktivieren.
    • Wenn Sie die synchrone Übertragung an einen Servicemitarbeiter verwenden, Virtual Agent-APISendet den Tippindikator, wenn er aktiviert ist:
      {
  "uiType": "ActionMsg",
  "actionType": "StartTypingIndicator",
}
    • Themen, die die folgenden Funktionen verwenden, werden im synchronen Modus nicht unterstützt: Datei-Upload , Aktionsdienstprogramm, Und Themenblock anhalten .
    Führen Sie die folgenden Schritte aus, um diese Funktionen zu deaktivieren und den synchronen Support zu aktivieren:
    1. Navigieren zu Alle > sys_cs_Channel.listan.
    2. Wählen Sie den Bot-zu-Bot-Datensatz aus.
    3. Löschen Sie Aktivieren Sie Benachrichtigungen Kontrollkästchen zum Deaktivieren.
    4. Wenn Sie im synchronen Modus nicht an einen Servicemitarbeiter übertragen, löschen Sie Support-Eingabeindikator Kontrollkästchen zum Deaktivieren.
    5. Wählen Sie aus Synchron Kontrollkästchen.
      Abbildung : 1. Bot-zu-Bot-Kanal mit aktivierter synchroner Unterstützung
      Die Konfiguration des Bot-zu-Bot-Kanals für den synchronen Modus zeigt die Indikatorfelder „Benachrichtigungen und Support aktivieren“ als deaktiviert an. Das Feld „synchron“ ist ausgewählt.
    6. Klicken Sie auf Aktualisieren.

    Unterstützung für Aktionsnachrichten

    Zusätzlich zur Übergabe von Nachrichten an ServiceNow® Virtual AgentSekundärer Bot, der primäre Bot oder Chat-Client kann Nachrichten über an einen Service Desk-Mitarbeiter übergeben Mitarbeiterchat. Verwenden Sie actionParameter, der im Anforderungstext übergeben wird, um anzugeben, wie der Inhalt behandelt werden soll.

    Virtual Agent-API Unterstützt die folgenden Aktionsnachrichtentypen:
    Tabelle : 1. Unterstützte Aktionsnachrichtentypen
    ActionType-Wert Beschreibung
    Chatunterheader Ausgehende Nachricht, die angibt, dass eine der folgenden Ereignisse aufgetreten ist:
    • Dynamische Übersetzung fehlgeschlagen.
    • Autopilot für Servicemitarbeiter wurde initiiert und abgeschlossen.
    StartSpinner Ausgehende Nachricht, die aufgrund asynchroner Prozesse, z. B. ein Drehfeld startet, wenn sich eine Nachricht im Status „Ausstehend“ befindet KI-SucheOder der Obszönitätsfilter.
    EndSpinner Ausgehende Nachricht, die den zuvor gesendeten Spinner stoppt.
    StartTypenIndikatorActionMsg Ausgehende Nachricht, die angibt, dass ein Anwender oder Service Desk-Mitarbeiter mit der Eingabe begonnen hat (nachdem ein Service Desk-Mitarbeiter den Chat akzeptiert hat).
    EndtypenIndikatorActionMsg Ausgehende Nachricht, die angibt, dass ein Anwender oder Service Desk-Mitarbeiter die Eingabe beendet hat.
    AbonniertSupportWarteschlange Gibt an, dass die Konversation auf die Supportwarteschlange festgelegt ist.
    AbonnementToChatPresence Ausgehende Nachricht, die angibt, dass eine Servicemitarbeiter-Konversation begonnen hat.
    Zu LiveAgent wechseln Ausgehende Nachricht, die angibt, dass ein Servicemitarbeiter die Konversation akzeptiert hat.
    Zu VirtualAgent wechseln Ausgehende Nachricht, die angibt, dass die Servicemitarbeiter-Sitzung beendet wurde und die Konversation an zurückgegeben wird Virtual Agent.
    Konversation wechseln Ausgehende Nachricht, die angibt, dass eine Benachrichtigung gesendet wurde. Dadurch wird eine neue Konversation erstellt, also Virtual AgentWechselt zur neuen Konversation.
    System Ausgehende Nachricht, die eine der folgenden Elemente angibt:
    • Ein Servicemitarbeiter ist in die Kat. getreten.
    • Entweder der Servicemitarbeiter oder der Anwender hat den Chat geschlossen.
    • Die Konversation mit einem Servicemitarbeiter ist abgelaufen.

    Unterstützung für Kennzeichnung „silentMessage“

    Eine stumme Nachricht ist eine Nachricht, die keine Antwort erfordert. Wenn Virtual AgentEmpfängt eine Anforderung mit silentMessage=true, Alle nachfolgenden Bot-Nachrichten werden bis unterdrückt Virtual AgentEmpfängt eine Anforderung zum Deaktivieren des stillen Modus ( silentMessage=false).

    Beispielnutzlast der Nachricht aus dem primären Bot:
    { 
   "token": "BOT_TOKEN",
   "botToBot": true,
   "clientSessionId": "884502214730301027f83ee4070f589a",
   "clientVariables": {},
   "requestId": "48450221d23030107300b7756770bc9b",
   "silentMessage": "true",
   "timestamp": 1623916324820,
   "timezone": "GMT",
   "userId": "abel.tuter",
   "emailId": "abel.tuter@example.com" 
}
    Hinweis:
    Wenn silentMessage=true, Benachrichtigungen werden nicht zugestellt.

    Sichere Datei-Uploads von einer privaten URL

    Virtual Agent-API Unterstützt Datei-Uploads mit einer Größe von bis zu 1 GB von einer privaten URL. Der primäre Bot muss die Anwender-ID, die optionale Anbieteranwendungs-ID und den Namen der Datei übergeben. Beachten Sie die folgenden Richtlinien:
    • ID der Anbieteranwendung ist optional.
    • Die Anwender-ID und die Anbieteranwendungs-ID müssen vor dem Dateinamen in der Nutzlast gesendet werden.
    • Der Endanwender muss über eine Rolle verfügen, die in angegeben ist glide.attachment.roleEigenschaft. Weitere Informationen finden Sie unter Zum Anhängen von Dateien ist eine Rolle erforderlich .
    • Standard- oder OAuth-Authentifizierung wird unterstützt, Nachrichtenauthentifizierung ist jedoch nicht.
    Beispielnutzlast der Nachricht aus dem primären Bot:   
    curl -X POST \
  https://instance.service-now.com/api/now/v1/cccif/media/upload \
  -H 'authorization: Basic YWRtaW46YWRtaW4=' \
  -H 'content-type: multipart/form-data; \
  -F user_id=xxxxxx \
  -F provider_application_id=optionalId \
  -F 'file=@SomeFile.png'
    Virtual Agent-API Sendet die folgende Beispiel-JSON:
    {
  "result": {
    "mediaUrl": "http://123.456.7.8:8080//api/now/v1/cs/media/string",
    "name":"imagefile.png",
    "state":"pending",
    "attachmentId":"abcdefghijklmno12345"
  }
}

    Erweiterungen des Mitarbeiterchat in Virtual Agent-APIVersion 3.14.3

    • Wenn der primäre Bot einen Chat an einen Servicemitarbeiter überträgt, Virtual Agent-APISendet die Agenten-ID zusätzlich zum Namen und Avatar des Agenten an den primären Bot.
    • Virtual Agent-API Sendet während einer laufenden Konversation den Chatverlauf vom primären Bot an einen Servicemitarbeiter in der Anforderung. Dieses Verhalten wird durch die folgende Systemeigenschaft gesteuert: allow_storing_history_in_ongoing-Conversation. Legen Sie den Wert der Eigenschaft auf „wahr“ fest, um den Chatverlauf an eine beliebige Stelle in der Anforderung zu senden.
    • Der Interaktionsdatensatz enthält das Transkript des Chatverlaufs zusammen mit dem Zeitstempel einzelner Nachrichten.