API für Sprachinteraktionsressourcen

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

    • Die Sprachinteraktion Die API stellt Endpunkte zum Transkribieren und Speichern von Sprachinteraktionen zwischen Service Desk-Mitarbeitern und Anrufern während einer Telefonkonversation bereit. Funktioniert in Verbindung mit Virtual AgentUnd ServicemitarbeiterChats.

    Sie können diese API verwenden, um transkribierte Nachrichten aus einem laufenden Telefonanruf in Echtzeit beizubehalten oder um eine vorhandene Sprachkonversationsaufzeichnung für historische Zwecke zu transkribieren und zu speichern. Transkribierte Nachrichten werden in angezeigt Mitarbeiterbereich, Damit Service Desk-Mitarbeiter Funktionen wie Service Desk-Mitarbeiter und Suche nutzen können, während sie mit einem Anrufer sprechen. Transkribierte Nachrichten werden in der Tabelle „Konversationsnachricht“ [sys_cs_message] beibehalten.

    Transkribierte Nachrichten im Mitarbeiterbereich

    Anruf-Flow

    Der folgende Anruf-Flow zeigt die Verwendung von Sprachinteraktion API zum Erstellen eines Sprachinteraktionsdatensatzes, zum Transkribieren und Speichern der Nachrichten in dieser Sprachkonversation und zum Schließen des Sprachkonversationsdatensatzes. Sie können auch Business-Regeln und andere Skripts verwenden, um diese Funktionalität auszuführen. Diese Art der Implementierung wird jedoch in diesem Abschnitt nicht behandelt.
    1. Rufen Sie zuerst an Sprachinteraktionsressource – POST /cs/Voice-InteraktionenEndpunkt zum Erstellen eines Sprachinteraktionsdatensatzes in der Tabelle „Interaktion“ [Interaktion].
    2. Rufen Sie dann an Sprachinteraktionsressource – POSTEN SIE /cs/Voice-Interaktionen/{interactionId}/messagesEndpunkt zum Speichern übersetzter Nachrichten aus der Sprachkonversation in der Konversationsnachrichtentabelle. Wenn Sie eine Echtzeitkonversation verarbeiten, sollten Sie diesen Endpunkt häufig anrufen, damit die Nachrichten in angezeigt werden MitarbeiterbereichZeitnah. Wenn Sie eine Aufzeichnung zu Verlaufszwecken verarbeiten, können Sie alle Nachrichten in einem einzelnen Endpunktaufruf übergeben.
    3. Sobald Sie mit dem Beibehalten der Sprachnachrichten fertig sind, rufen Sie an Sprachinteraktionsressource – PATCH /cs/Voice-Interactions/{interactionId}/StateEndpunkt zum Beenden der Erfassung und Schließen des Sprachinteraktionsdatensatzes.

    Verfügbarkeit

    Diese API ist in der Basis verfügbar ServiceNowSystem. Der Zugriff wird durch die ACLs eingeschränkt, die für die Tabellen „Interaktion“ [Interaktion] und „Konversation“ [sys_cs_Conversation] festgelegt werden.

    Sprachinteraktionsressource – PATCH /cs/Voice-Interactions/{interactionId}/State

    Beendet die angegebene Sprachinteraktion. Nach dem Anruf werden keine zusätzlichen Sprachnachrichten für die Telefonkonversation übersetzt und gespeichert.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cs/Voice-Interaktionen/{interactionId}/Status

    Standard-URL: /api/now/v1/cs/Voice-Interaktionen/{interactionId}/State

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    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
    interactionId SYS_ID des Interaktionsdatensatzes, dessen Sprachinteraktion beendet werden soll. Von zurückgegeben Sprachinteraktionsressource – POST /cs/Voice-InteraktionenEndpunkt.

    Datentyp: Zeichenfolge

    Tabelle: Interaktion [Interaktion]
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Record-URL URL, in der sich die ursprüngliche Sprachaufzeichnung befindet.

    Wenn dies konfiguriert ist, wird diese URL in angezeigt Mitarbeiterbereich.

    Datentyp: Zeichenfolge

    Standard: Keine
    Staat Erforderlich. Status der Sprachinteraktion.

    Nur unterstützter Wert: Closed_complete

    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 .

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 5. Antwort-Header
    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 .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Falsch formatierte JSON oder erforderliche Parameter 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 Status des Vorgangs.
    Mögliche Werte:
    • Erfolg
    • Fehlgeschlagen

    Wenn ein Fehler auftritt, wird auch eine Meldung zurückgegeben, die den Fehler beschreibt. Wenn der Fehler auf liegt ServiceNowInstanz: Die Instanz protokolliert die zugeordnete Stapelverfolgung.

    Curl-Anforderung

    Das folgende Beispiel zeigt, wie eine Sprachinstanz beendet wird.

    curl "http://instance.servicenow.com/api/now/v1/ cs/voice-interactions/86837a386f0331003b3c498f5d3ee4ca/state" \ 
--request PATCH \
--header "Content-Type: application/json" \
--header "Accept:application/json" \
--user 'username':'password' \
-d {
  "state": "closed_complete",
  "recordingURL": "https: //zoom_instance/rec/QbF7XmPFHPlX1LG"
}’

    Antwort:

    {
  "result": "Success"
}

    Sprachinteraktionsressource – POST /cs/Voice-Interaktionen

    Erstellt einen Sprachinteraktionsdatensatz in der Tabelle „Interaktion“ [Interaktion].

    Sie müssen diesen Datensatz erstellen, bevor Sie versuchen, transkribierte Sprachnachrichten zu speichern. Sie können diesen Endpunkt auch verwenden, um einem bestimmten Service Desk-Mitarbeiter einen Anruf zuzuweisen, indem Sie seine spezifische Anwender-ID übergeben.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cs/Voice-Interaktionen

    Standard-URL: /api/now/v1/cs/Voice-Interaktionen

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    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. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    agentId Eindeutiger Bezeichner des Service Desk-Mitarbeiters, dem die Sprachinteraktion zugewiesen werden soll.

    Datentyp: Zeichenfolge

    Standard: Virtual Agent Aufrufen
    Anrufertelefonnummer 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
    ClientSessionId Eindeutiger Bezeichner eines Datensatzes in einem externen System, der zum Nachverfolgen dieses Telefonanrufs verwendet wird. Mit dieser Information werden die Datensätze zwischen den beiden Systemen verknüpft.

    Datentyp: Zeichenfolge

    Standard: Keine
    eingehendeId Eindeutiger Bezeichner des Anwendungsanbieters für den Sprachdienst.

    Datentyp: Zeichenfolge

    Standard: Aus Chat abgerufen
    userId Erforderlich. Telefonnummer des Anrufers, der den Anruf getätigt hat, der der Sprachtransaktion zugeordnet ist.

    Datentyp: Zeichenfolge

    Format: Definiert durch die Software, die das Sprachkonversationsskript erstellt hat. Normalerweise entspricht der E.164-Standard.

    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 .

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 11. Antwort-Header
    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 .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Falsch formatierte JSON oder erforderliche Parameter 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
    interactionId SYS_ID des neu erstellten Sprachinteraktionsdatensatzes.
    Verwenden Sie diese sys_ID, wenn:

    Datentyp: Zeichenfolge

    Tabelle: Interaktion [Interaktion]

    Curl-Anforderung

    Das folgende Codebeispiel zeigt, wie Sie eine Sprachinteraktion initiieren und den Anruf an einen bestimmten Service Desk-Mitarbeiter weiterleiten.

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password' \ 
--header "Content-Type: application/json"\ 
-d '{ 
  "userId": "+14089178877",
  "agentId": "beth.anglin",
  "callerPhoneNumber": "+14089178878",
  "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z"
}'

    Antwort:

    {
  "result": {
    "interactionId": "4462cb4753751110b6e8ddeeff7b12ca"
  }
}

    Sprachinteraktionsressource – /cs/Voice-Interaktionen/{interactionId}/Konversation POSTEN

    Erstellt einen Konversationsdatensatz in der Konversationstabelle [sys_cs_Conversation] für die angegebene Interaktion.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cs/Voice-Interaktionen/{interactionId}/Konversation

    Standard-URL: /api/now/v1/cs/Voice-Interaktionen/{interactionId}/Konversation

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfad-Parameter
    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
    interactionId SYS_ID des Interaktionsdatensatzes, für den der Konversationsdatensatz erstellt werden soll. Dieser Wert wird von zurückgegeben Sprachinteraktionsressource – POST /cs/Voice-InteraktionenEndpunkt und in der Interaktionstabelle [Interaktion] gespeichert.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    agentId Eindeutiger Bezeichner des Service Desk-Mitarbeiters, dem die Sprachinteraktion zugewiesen werden soll.

    Datentyp: Zeichenfolge

    Standard: Virtual Agent Aufrufen
    Anrufertelefonnummer 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
    ClientSessionId Eindeutiger Bezeichner eines Datensatzes in einem externen System, der zum Nachverfolgen dieses Telefonanrufs verwendet wird. Mit dieser Information werden die Datensätze zwischen den beiden Systemen verknüpft.

    Datentyp: Zeichenfolge

    Standard: Keine
    eingehendeId Eindeutiger Bezeichner des Anwendungsanbieters für den Sprachdienst.

    Datentyp: Zeichenfolge

    Standard: Aus dem Chat abrufen
    userId Erforderlich. Telefonnummer des Anrufers, der den Anruf getätigt hat, der der Sprachtransaktion zugeordnet ist.

    Datentyp: Zeichenfolge

    Format: Definiert durch die Software, die das Sprachkonversationsskript erstellt hat. Normalerweise entspricht der E.164-Standard.

    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 .

    Tabelle : 16. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 17. Antwort-Header
    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 .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Falsch formatierte JSON oder erforderliche Parameter 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
    conversationId SYS_ID des neu erstellten Konversationsdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Konversation [sys_cs_Conversation]

    Curl-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions/7662cb4721751ea0b6e8dda1b27b131f/conversation" \  
--request POST \  
--header "Accept:application/json" \  
--user 'username':'password' \  
--header "Content-Type: application/json"\  
-d '{  
  "userId": "+14089178877", 
  "agentId": "admin@example.com", 
  "callerPhoneNumber": "+14089178878", 
  "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z" 
}'

    Antwort:

    { 
  "result": "a47e1afdb7471110b6e8bc15ae11a934" 
}

    Sprachinteraktionsressource – POSTEN SIE /cs/Voice-Interaktionen/{interactionId}/messages

    Fügt dem angegebenen Sprachtransaktionsdatensatz die angegebenen Sprachkonversationsnachrichten hinzu. Diese Nachrichten werden normalerweise mit Software von Drittanbietern generiert. Derzeit wird nur Amazon Connect unterstützt.

    Sie können diesen Endpunkt während der Echtzeit-Transkription des Anrufs mehrmals aufrufen oder alle Nachrichten in einem einzigen Anruf übergeben, wenn Sie den Anruf zu historischen Zwecken transkribieren. Wenn Sie eine Echtzeitkonversation verarbeiten, sollten Sie diesen Endpunkt häufig anrufen, damit die Nachrichten in angezeigt werden MitarbeiterbereichZeitnah. Nachrichten werden basierend auf ihren Start- und Endzeiten im Verhältnis zum Beginn des Anrufs sortiert.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cs/Voice-Interaktionen/{interactionId}/messages

    Standard-URL: /api/now/v1/cs/Voice-Interaktionen/{interactionId}/messages

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfad-Parameter
    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
    interactionId SYS_ID des Interaktionsdatensatzes, dem die angegebenen Nachrichten hinzugefügt werden sollen. Dieser Wert wird von zurückgegeben Sprachinteraktionsressource – POST /cs/Voice-InteraktionenEndpunkt und in der Interaktionstabelle [Interaktion] gespeichert.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstext-Parameter (Amazon Connect)
    Name Beschreibung
    <json_string>
    Liste der Nachrichten, die an die angegebene Sprachinteraktion angehängt werden sollen.
    "<json_string>":[
  {
    "attributes": [Array],
    "beginOffsetMillis": Long,
    "content": "String"
    "endOffsetMillis": Long,
    "id": "String",
    "isEvent": Boolean,
    "isInternalMessage": Boolean,
    "loudnessScore": "Number",
    "participantId": "String",
    "sentiment": "String"
  }
]
    <json_string>.Attribute
    Schlüssel-Wert-Paare, die der Sprachinteraktion zugeordnet werden sollen.

    Dies kann eine beliebige Art von Datenobjekten sein, von einfachen Objekten bis zu komplexen zusammengesetzten Objekten. Sie werden als eindeutige Bezeichner beim Aufrufen von Amazon-Webservices-APIs verwendet.

    Datentyp: Array von Objekten

    Standard: Keine
    <json_string>.beginOffsetMillis Erforderlich. Zeitversatz zwischen dem Beginn der Sprachinteraktion und dem Beginn der zugehörigen Nachricht. Beispiel: „BeginOffsetMillis“: 2650.

    Datentyp: Lang

    Einheit: Millisekunden
    <json_string>.Inhalt Erforderlich. Text der Nachricht, die der Sprachinteraktion hinzugefügt werden soll.

    Datentyp: Zeichenfolge
    <json_string>.endOffsetMillis Erforderlich. Zeitversatz zwischen dem Beginn der Sprachinteraktion und dem Ende der Nachricht. Beispiel: „EndOffsetMillis“: 9380.

    Datentyp: Lang

    Einheit: Millisekunden
    <json_string>.ID Nachrichten-UUID der Quelle dieser Sprachkonversation, z. B. für AmazonConnect. Legt den Spaltenwert der Quellnachrichten-ID fest.

    Datentyp: Zeichenfolge

    Standard: Keine
    <json_string>.isEreignis
    Von Amazon Connect festgelegt, aber derzeit nicht von der Methode verwendet. Kennzeichnung, die angibt, ob die zugeordnete Nachricht ein Ereignis ist.
    Gültige Werte:
    • Wahr: Nachricht ist ein Ereignis.
    • Falsch: Nachricht ist kein Ereignis.

    Datentyp: Boolescher Wert

    Standard: Falsch
    <json_string>.isInternalNachricht
    Kennzeichnung, die angibt, ob dies eine interne Nachricht ist und dem Anrufer nicht angezeigt werden soll.

    Transkriptionen werden normalerweise als interne Nachrichten betrachtet und werden nur für den Service Desk-Mitarbeiter und nicht für den Anrufer angezeigt. Darüber hinaus wird das Flüstern von Service Desk-Mitarbeitern verwendet, wenn eine stille Drittpartei mit einer stillen Drittpartei chattet oder in eine Telefonkonversation gebracht wird, ohne dass der Anrufer dies weiß und einem Service Desk-Mitarbeiter Rat anbietet. Der Anrufer hört oder sieht diese Nachrichten nicht, der Service Desk-Mitarbeiter jedoch.

    Gültige Werte:
    • Wahr: Interne Nachricht, nicht dem Anrufer angezeigt.
    • Falsch: Keine interne Nachricht, wird dem Anrufer angezeigt.

    Datentyp: Boolescher Wert

    Standard: Falsch
    <json_string>.LoudnessScore
    Messung, wie laut ein Kunde oder Service Desk-Mitarbeiter während eines Anrufs spricht.

    Kontaktobjektiv zeigt eine Analyse der Konversation an, die zeigt, wo sie möglicherweise laut sprechen und eine negative Stimmung haben.

    Datentyp: Zahl

    Bereich: -1,0 (negativ) bis 1,0 (positiv)

    Standard: Null
    <json_string>.partizipantId
    Erforderlich. Teilnehmer, der der Nachricht zugeordnet ist.
    Gültige Werte:
    • SERVICE DESK-MITARBEITER
    • KUNDE

    Datentyp: Zeichenfolge
    <json_string>.Stimmung
    Stimmung der Nachricht.

    Dieser Wert wird von einem Drittanbieter generiert. Basierend auf ServiceNowInstanzkonfigurationseinstellungen. Dieser Wert wird dann entweder positiv, negativ oder neutral übersetzt und im Konversations- und Interaktionsdatensatz gespeichert.

    Gültige Werte:
    • NEGATIV
    • NEUTRAL
    • POSITIV

    Datentyp: Zeichenfolge

    Standard: Null

    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 .

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 23. Antwort-Header
    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 .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Falsch formatierte JSON oder erforderliche Parameter 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 Nachricht, die die Ergebnisse des Anrufs beschreibt.

    Datentyp: Zeichenfolge
    Konversations-ID SYS_ID des Datensatzes der Sprach-Interaktionsnachricht, der erstellt wurde.

    Datentyp: Zeichenfolge

    Tabelle: Sprachtranskript-Konversationsnachricht [sys_cs_message_voice_transcript]

    Curl-Anforderung

    Das folgende Beispiel zeigt, wie Sie einem vorhandenen Sprachinteraktionsdatensatz Nachrichten hinzufügen.

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions/86837a386f0331003b3c498f5d3ee4ca/messages" \ 
--request POST \
--header "Accept:application/json" \
--header "Content-Type: application/json"\ 
--user 'username':'password' \
-d ' [ 
  { 
    "isEvent": "false",  
    "isInternalMessage": "false",  
    "beginOffsetMillis": 10000,  
    "content": "This is John. How can I help you?",  
    "endOffsetMillis": 15000,  
    "id": "954c4edc-31a8-48b0-8f6e-7fa0c4ca00a8",  
    "participantId": "AGENT",  
    "sentiment": "NEUTRAL",  
    "loudnessScore": "null",  
    "attributes": [{  
      "key": "key1",  
      "value": "value1"  
      }, {  
      "key": "key2",  
      "value": "value2"  
    }] 
  },  
  {  
    "isEvent": "false",  
    "isInternalMessage": "false",  
    "beginOffsetMillis": 20000,  
    "content": "Uh, yes, John. Um, I'm a little very frustrated right now.",  
    "endOffsetMillis": 25000,  
    "id": "18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f",  
    "participantId": "CUSTOMER",  
    "sentiment": "NEGATIVE"  
  },  
  {  
    "isEvent": "false",  
    "isInternalMessage": "false",  
    "beginOffsetMillis": 30000,  
    "content": "I am sorry to hear that",  
    "endOffsetMillis": 35000,  
    "id": "18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f",  
    "participantId": "AGENT",  
    "sentiment": "NEGATIVE",  
 
  },  
  {  
    "isEvent":"false",
    "isInternalMessage":"false",
    "beginOffsetMillis":40000,
    "content":"Can you help me with my insurance? My ssn is 123-12-1234",
    "endOffsetMillis":45000,
    "id":"ab09b3b6-23fd-4e41-be05-6b2b53c19059",
    "participantId":"CUSTOMER",
    "sentiment":"NEUTRAL" 
  },  
  {  
    "isEvent":"False",
    "isInternalMessage":"False",
    "beginOffsetMillis":50000, 
    "content":"Of course, let me check your account",
    "endOffsetMillis":55000,
    "id":"18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f",
    "participantId":"AGENT",
    "sentiment":"NEUTRAL" 
  }  
]'

    Antwort:

    { 
  "result": "Voice conversation transcript has been successfully saved. Conversation id: 8439d3c753b51110b6e8ddeeff7b12e2" 
}

    Sprachinteraktionsressource – POST /cs/Voice-Interaktionen/Transcript

    Fügt einer vorhandenen Sprachinteraktion Nachrichten hinzu, nachdem ein Anruf abgeschlossen wurde. Sie können diese API verwenden, um transkribierte Nachrichten eines Sprachanrufs zwischen einem Service Desk-Mitarbeiter und einem Anrufer anzuhängen.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cs/Voice-Interaktionen/{interactionId}/Transcript

    Standard-URL: /api/now/v1/cs/Voice-Interaktionen/{interactionId}/Transcript

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfad-Parameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Konversationgestartet Startzeit der Konversation.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT HH:MM:SS

    Tabelle: Interaktion [Interaktion]
    interactionId SYS_ID des Interaktionsdatensatzes, dem die angegebenen Nachrichten hinzugefügt werden sollen. Dieser Wert wird von zurückgegeben Sprachinteraktionsressource – POST /cs/Voice-InteraktionenEndpunkt.

    Datentyp: Zeichenfolge

    Tabelle: Interaktion [Interaktion]
    Quelle Name des Kanals, der das Transkript der Konversationsinteraktion ursprünglich erstellt hat.

    Derzeit ist der einzige unterstützte Wert Amazon Connect .

    Datentyp: Zeichenfolge
    transcript Liste der Nachrichten, die an die angegebene Sprachinteraktion angehängt werden sollen.
    "transcript":[
  {
    "attributes": [Array],
    "beginOffsetMillis": Long,
    "content": "String"
    "endOffsetMillis": Long,
    "id": "String",
    "isEvent": Boolean,
    "isInternalMessage": Boolean,
    "loudnessScore": "String",
    "participantId": "String",
    "sentiment": "String"
  }
]

    Datentyp: Array von Objekten
    Transkript.attributes
    Schlüssel-Wert-Paare, die der Sprachinteraktion zugeordnet werden sollen.

    Dies kann eine beliebige Art von Datenobjekten sein, von einfachen Objekten bis zu komplexen zusammengesetzten Objekten. Sie werden als eindeutige Bezeichner beim Aufrufen von Amazon-Webservices-APIs verwendet.

    Datentyp: Array von Objekten

    Standard: Keine
    transcript.beginOffsetMillis Erforderlich. Zeitversatz zwischen dem Beginn der Sprachinteraktion und dem Beginn der zugehörigen Nachricht. Beispiel: „BeginOffsetMillis“: 2650.

    Datentyp: Lang

    Einheit: Millisekunden
    Transkript.Content Erforderlich. Text der Nachricht, die der Sprachinteraktion hinzugefügt werden soll.

    Datentyp: Zeichenfolge
    Transkript.endOffsetMillis Erforderlich. Zeitversatz zwischen dem Beginn der Sprachinteraktion und dem Ende der Nachricht. Beispiel: „EndOffsetMillis“: 9380.

    Datentyp: Lang

    Einheit: Millisekunden
    transcript.id Nachrichten-UUID der Quelle dieser Sprachkonversation, z. B. für AmazonConnect. Legt den Spaltenwert der Quellnachrichten-ID fest.

    Datentyp: Zeichenfolge

    Standard: Keine
    Transcript.isEreignis
    Von Amazon Connect festgelegt, aber derzeit nicht von der Methode verwendet. Kennzeichnung, die angibt, ob die zugeordnete Nachricht ein Ereignis ist.
    Gültige Werte:
    • Wahr: Nachricht ist ein Ereignis.
    • Falsch: Nachricht ist kein Ereignis.

    Datentyp: Boolescher Wert

    Standard: Falsch
    Transcript.isInternalNachricht
    Kennzeichnung, die angibt, ob dies eine interne Nachricht ist und dem Anrufer nicht angezeigt werden soll.

    Transkriptionen werden normalerweise als interne Nachrichten betrachtet und werden nur für den Service Desk-Mitarbeiter und nicht für den Anrufer angezeigt. Darüber hinaus wird das Flüstern von Service Desk-Mitarbeitern verwendet, wenn eine stille Drittpartei mit einer stillen Drittpartei chattet oder in eine Telefonkonversation gebracht wird, ohne dass der Anrufer dies weiß und einem Service Desk-Mitarbeiter Rat anbietet. Der Anrufer hört oder sieht diese Nachrichten nicht, der Service Desk-Mitarbeiter jedoch.

    Gültige Werte:
    • Wahr: Interne Nachricht, nicht dem Anrufer angezeigt.
    • Falsch: Keine interne Nachricht, wird dem Anrufer angezeigt.

    Datentyp: Boolescher Wert

    Standard: Falsch
    Transcript.LoudnessScore
    Messung, wie laut ein Kunde oder Service Desk-Mitarbeiter während eines Anrufs spricht.

    Kontaktobjektiv zeigt eine Analyse der Konversation an, die zeigt, wo sie möglicherweise laut sprechen und eine negative Stimmung haben.

    Datentyp: Zahl

    Bereich: -1,0 (negativ) bis 1,0 (positiv)

    Standard: Null
    Transkript.partizipantId
    Erforderlich. Teilnehmer, der der Nachricht zugeordnet ist.
    Gültige Werte:
    • SERVICE DESK-MITARBEITER
    • KUNDE

    Datentyp: Zeichenfolge
    transcript.sentiment
    Stimmung der Nachricht.

    Dieser Wert wird von einem Drittanbieter generiert. Basierend auf ServiceNowInstanzkonfigurationseinstellungen. Dieser Wert wird dann entweder positiv, negativ oder neutral übersetzt und im Konversations- und Interaktionsdatensatz gespeichert.

    Gültige Werte:
    • NEGATIV
    • NEUTRAL
    • POSITIV

    Datentyp: Zeichenfolge

    Standard: Null

    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 .

    Tabelle : 28. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 29. Antwort-Header
    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 .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Falsch formatierte JSON oder erforderliche Parameter 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 Nachricht, die die Ergebnisse des Anrufs beschreibt.

    Datentyp: Zeichenfolge
    Konversations-ID SYS_ID der Sprachkonversationstabelle, an die die Nachrichten angehängt wurden.

    Datentyp: Zeichenfolge

    Tabelle: Konversation [sys_cs_message_conversation]

    Curl-Anforderung

    Das folgende Beispiel zeigt, wie Sie einem vorhandenen Sprachinteraktionsdatensatz Nachrichten hinzufügen.

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions/transcript" \  
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type: application/json"\  
--user 'username':'password' \ 
-d ' { 
  "interactionId": "e67a6c30c7233010967a34c91dc26068", 
  "source": "Amazon Connect", 
  "conversationStarted": "2021-08-06 15:07:51", 
  "transcript": [ 
    { 
      "isEvent": "False", 
      "isInternalMessage": "False", 
      "beginOffsetMillis": 100000, 
      "content": "This is John. How can I help you?", 
      "endOffsetMillis": 150000, 
      "id": "954c4edc-31a8-48b0-8f6e-7fa0c4ca00a8", 
      "participantId": "AGENT", 
      "sentiment": "NEUTRAL" 
    }, 
    { 
      "isEvent": "False",
      "isInternalMessage": "False", 
      "beginOffsetMillis": 200000, 
      "content": "Uh, yes, John. Um, I'm a little frustrated right now.", 
      "endOffsetMillis": 25000, 
      "id": "18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f", 
      "participantId": "CUSTOMER", 
      "sentiment": "NEGATIVE" 
    } 
  ] 
} ' 

    Antwort:

    {  
  "result": "Voice conversation transcript has been successfully saved. Conversation id: 8439d3c753b51110b6e8ddeeff7b12e2"  
}