---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference
Release :
- xanadu
ft:locale :
- de-DE
ft:publication_title :
- Xanadu-API-Referenz
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# API für Sprachinteraktionsressourcen
# API für Sprachinteraktionsressourcen {#ariaid-title1}
* Freigeben Version: Xanadu
*
* Aktualisiert 1. August 2024
*
*  15 Minuten Lesedauer
Die Sprachinteraktions -API bietet Endpunkte zum Transkribieren und Speichern von Sprachinteraktionen zwischen Service Desk-Mitarbeitern und Anrufern während eines Telefongesprächs. Es funktioniert in Verbindung mit den Chats Virtual Agent und Service Desk-Mitarbeiter.
Sie können diese API verwenden, um transkribierte Nachrichten aus einem laufenden Telefonanruf in Echtzeit beizubehalten oder eine vorhandene Sprachkonversationsaufzeichnung für Verlaufszwecke zu transkribieren und zu speichern. Transkribierte Nachrichten werden in Mitarbeiterbereichangezeigt, sodass Service Desk-Mitarbeiter Funktionen wie Agent Assist und Suche nutzen können, während sie mit einem Anrufer sprechen. Transkribierte Nachrichten werden in der Tabelle „Konversationsnachricht" \[sys_cs_message\] gespeichert.
## Anruf-Flow
Der folgende Anruf-Flow zeigt, wie Sie die Sprachinteraktions -API verwenden, um einen Sprachinteraktionsdatensatz zu erstellen, die Nachrichten in dieser Sprachkonversation zu transkribieren, zu speichern und den Sprachkonversationsdatensatz dann zu schließen. Sie können auch Business-Regeln und andere Skripts verwenden, um diese Funktionalität auszuführen. Diese Art der Implementierung wird in diesem Abschnitt jedoch nicht behandelt.
1. Rufen Sie zuerst den Endpunkt [Sprachinteraktionsressource -- POST /cs/voice-interactions](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-POST-voice_inter "Erstellt einen Sprachinteraktionsdatensatz in der Interaktionstabelle [interaction].") auf, um einen Sprachinteraktionsdatensatz in der Interaktionstabelle \[interaction\] zu erstellen.
2. Rufen Sie dann den -Endpunkt [Sprachinteraktionsressource -- POST /cs/voice-interactions/{interactionId}/messages](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-POST-voice_inter-messages "Fügt die angegebenen Sprachkonversationsnachrichten dem angegebenen Sprachtransaktionsdatensatz hinzu. Diese Nachrichten werden normalerweise mit Software von Drittanbietern generiert. Derzeit wird nur Amazon Connect unterstützt.") auf, um übersetzte Nachrichten aus der Sprachkonversation in der Konversationsnachrichtentabelle zu speichern. Wenn Sie eine Echtzeitkonversation verarbeiten, sollten Sie diesen Endpunkt häufig aufrufen, damit die Nachrichten rechtzeitig in Mitarbeiterbereich angezeigt werden. Wenn Sie eine Aufzeichnung für Verlaufszwecke verarbeiten, können Sie alle Nachrichten in einem einzelnen Endpunktaufruf übergeben.
3. Wenn Sie mit dem Beibehalten der Sprachnachrichten fertig sind, rufen Sie den Endpunkt [Sprachinteraktionsressource -- PATCH /cs/voice-interactions/{interactionId}/state](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-PATCH-voice_inter-state "Beendet die angegebene Sprachinteraktion. Nach dem Anruf werden keine zusätzlichen Sprachnachrichten für das Telefongespräch übersetzt und gespeichert.") auf, um die Erfassung zu beenden und den Sprachinteraktionsdatensatz zu schließen.
## Verfügbarkeit
Diese API ist im Basissystem ServiceNow verfügbar. Der Zugriff wird durch die ACLs eingeschränkt, die auf die Tabellen „Interaktion" \[interaction\] und „Konversation" \[sys_cs_conversation\] angewendet werden.
## Sprachinteraktionsressource -- PATCH /cs/voice-interactions/{interactionId}/state {#ariaid-title2}
Beendet die angegebene Sprachinteraktion. Nach dem Anruf werden keine zusätzlichen Sprachnachrichten für das Telefongespräch übersetzt und gespeichert.
### URL-Format
URL mit Versionsnummer: /api/now/{api_version}/cs/voice-interactions/{interactionId}/state
Standard-URL: /api/now/v1/cs/voice-interactions/{interactionId}/state
### Unterstützte Anforderungsparameter
{#vir-PATCH-voice_inter-state__entry__2}{#vir-PATCH-voice_inter-state__version-RESTAPI}
| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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. Befindet sich in der Interaktionstabelle \[interaction\] und wird vom Endpunkt [Sprachinteraktionsressource -- POST /cs/voice-interactions](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-POST-voice_inter "Erstellt einen Sprachinteraktionsdatensatz in der Interaktionstabelle [interaction].") zurückgegeben. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfadparameter]
{#vir-PATCH-voice_inter-state__entry__8}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 2. Abfrageparameter]
{#vir-PATCH-voice_inter-state__entry__12}
| Name | Beschreibung |
|-|-|
| recordingURL | URL, unter der sich die ursprüngliche Sprachaufzeichnung befindet. Bei entsprechender Konfiguration wird diese URL unter Mitarbeiterbereichangezeigt. Datentyp: Zeichenfolge Standard: Keine |
| Staat | Erforderlich. Status der Sprachinteraktion. Einziger unterstützter Wert: closed_complete Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstextparameter (XML oder JSON)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#vir-PATCH-voice_inter-state__entry__18}{#vir-PATCH-voice_inter-state__accept-RESTAPI}{#vir-PATCH-voice_inter-state__content_type-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen]
{#vir-PATCH-voice_inter-state__entry__24}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 5. Antwortkopfzeilen]
### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#vir-PATCH-voice_inter-state__entry__28}{#vir-PATCH-voice_inter-state__entry-200-status-code}{#vir-PATCH-voice_inter-state__entry-500-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Falsch formatiertes JSON oder erforderliche Parameter wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#vir-PATCH-voice_inter-state__entry__36}
| 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 in der Instanz ServiceNow auftritt, protokolliert die Instanz den zugehörigen Stack Trace. |
[ ]
### 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-interactions {#ariaid-title3}
Erstellt einen Sprachinteraktionsdatensatz in der Interaktionstabelle \[interaction\].
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 dessen spezifische Anwender-ID übergeben.
### URL-Format
URL mit Versionsnummer: /api/now/{api_version}/cs/voice-interactions
Standard-URL: /api/now/v1/cs/voice-interactions
### Unterstützte Anforderungsparameter
{#vir-POST-voice_inter__entry__2}{#vir-POST-voice_inter__version-RESTAPI}
| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 7. Pfadparameter]
{#vir-POST-voice_inter__entry__6}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 8. Abfrageparameter]
{#vir-POST-voice_inter__entry__10}
| Name | Beschreibung |
|-|-|
| agentId | Eindeutiger Bezeichner des Service Desk-Mitarbeiters, dem die Sprachinteraktion zugewiesen werden soll. Befindet sich im Feld „Anwender-ID" in der Tabelle „Benutzer" \[sys_user\]. Datentyp: Zeichenfolge Standard: Virtual Agent aufrufen |
| callerPhoneNumber | Rückruf-Telefonnummer des Anrufers. Dies ist die Nummer, unter der der Service Desk-Mitarbeiter den Anrufer erreicht, falls der Anruf unterbrochen wird. Datentyp: Zeichenfolge Format: Entspricht Standard E.164 Standard: Keine |
| clientSessionId | Eindeutiger Bezeichner eines Datensatzes in einem externen System, der zur Nachverfolgung dieses Telefonanrufs verwendet wird. Diese Informationen verknüpfen die Datensätze zwischen den beiden Systemen. Datentyp: Zeichenfolge Standard: Keine |
| eingehendeId | Eindeutiger Bezeichner des Anwendungsanbieters für den Sprachservice. Zu finden im Feld Eingehende ID in der Tabelle „Anbieterkanalanwendung" \[sys_cs_provider_application\]. Datentyp: Zeichenfolge Standard: Aus Chat abgerufen |
| userId | Erforderlich Telefonnummer des Anrufers, der den der Sprachtransaktion zugeordneten Anruf getätigt hat. Datentyp: Zeichenfolge Format: Wird von der Software definiert, die das Sprachkonversationsskript erstellt hat. Normalerweise konform mit dem E.164-Standard. |
[Tabelle : 9. Anforderungstextparameter (XML oder JSON)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#vir-POST-voice_inter__entry__22}{#vir-POST-voice_inter__accept-RESTAPI}{#vir-POST-voice_inter__content_type-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 10. Anforderungskopfzeilen]
{#vir-POST-voice_inter__entry__28}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 11. Antwortkopfzeilen]
### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#vir-POST-voice_inter__entry__32}{#vir-POST-voice_inter__entry-200-status-code}{#vir-POST-voice_inter__entry-500-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Falsch formatiertes JSON oder erforderliche Parameter wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 12. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#vir-POST-voice_inter__entry__40}
| Name | Beschreibung |
|-|-|
| interactionId | Sys_id des neu erstellten Sprachinteraktionsdatensatzes. Befindet sich in der Interaktionstabelle \[interaction\]. Diese sys_id verwenden, wenn: * Durch Aufrufen des Endpunkts [Sprachinteraktionsressource -- POST /cs/voice-interactions/{interactionId}/messages](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-POST-voice_inter-messages "Fügt die angegebenen Sprachkonversationsnachrichten dem angegebenen Sprachtransaktionsdatensatz hinzu. Diese Nachrichten werden normalerweise mit Software von Drittanbietern generiert. Derzeit wird nur Amazon Connect unterstützt."), um der Sprachinteraktion eine Nachricht hinzuzufügen * Aufrufen des Endpunkts [Sprachinteraktionsressource -- PATCH /cs/voice-interactions/{interactionId}/state](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-PATCH-voice_inter-state "Beendet die angegebene Sprachinteraktion. Nach dem Anruf werden keine zusätzlichen Sprachnachrichten für das Telefongespräch übersetzt und gespeichert."), um die Sprachinteraktion zu beenden. Datentyp: Zeichenfolge |
[ ]
### cURL-Anforderung
Das folgende Codebeispiel zeigt, wie Sie eine Sprachinteraktion initiieren und den Anruf an einen bestimmten Service Desk-Mitarbeiter übergeben.
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 -- POST /cs/voice-interactions/{interactionId}/conversation {#ariaid-title4}
Erstellt einen Konversationsdatensatz in der Konversationstabelle \[sys_cs_conversation\] für die angegebene Interaktion.
### URL-Format
URL mit Versionsnummer: /api/now/{api_version}/cs/voice-interactions/{interactionId}/conversation
Standard-URL: /api/now/v1/cs/voice-interactions/{interactionId}/conversation
### Unterstützte Anforderungsparameter
{#vir-POST-voice_inter-conver__entry__2}{#vir-POST-voice_inter-conver__version-RESTAPI}
| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 vom Endpunkt [Sprachinteraktionsressource -- POST /cs/voice-interactions](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-POST-voice_inter "Erstellt einen Sprachinteraktionsdatensatz in der Interaktionstabelle [interaction].") zurückgegeben und in der Interaktionstabelle \[interaction\] gespeichert. Datentyp: Zeichenfolge |
[Tabelle : 13. Pfadparameter]
{#vir-POST-voice_inter-conver__entry__8}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 14. Abfrageparameter]
{#vir-POST-voice_inter-conver__entry__12}
| Name | Beschreibung |
|-|-|
| agentId | Eindeutiger Bezeichner des Service Desk-Mitarbeiters, dem die Sprachinteraktion zugewiesen werden soll. Befindet sich im Feld „Anwender-ID" in der Tabelle „Benutzer" \[sys_user\]. Datentyp: Zeichenfolge Standard: Virtual Agent aufrufen |
| callerPhoneNumber | Rückruf-Telefonnummer des Anrufers. Dies ist die Nummer, unter der der Service Desk-Mitarbeiter den Anrufer erreicht, falls der Anruf unterbrochen wird. Datentyp: Zeichenfolge Format: Entspricht Standard E.164 Standard: Keine |
| clientSessionId | Eindeutiger Bezeichner eines Datensatzes in einem externen System, der zur Nachverfolgung dieses Telefonanrufs verwendet wird. Diese Informationen verknüpfen die Datensätze zwischen den beiden Systemen. Datentyp: Zeichenfolge Standard: Keine |
| eingehendeId | Eindeutiger Bezeichner des Anwendungsanbieters für den Sprachservice. Zu finden im Feld Eingehende ID in der Tabelle „Anbieterkanalanwendung" \[sys_cs_provider_application\]. Datentyp: Zeichenfolge Standard: Aus dem Chat abrufen |
| userId | Erforderlich Telefonnummer des Anrufers, der den der Sprachtransaktion zugeordneten Anruf getätigt hat. Datentyp: Zeichenfolge Format: Wird von der Software definiert, die das Sprachkonversationsskript erstellt hat. Normalerweise konform mit dem E.164-Standard. |
[Tabelle : 15. Anforderungstextparameter (XML oder JSON)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#vir-POST-voice_inter-conver__entry__24}{#vir-POST-voice_inter-conver__accept-RESTAPI}{#vir-POST-voice_inter-conver__content_type-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 16. Anforderungskopfzeilen]
{#vir-POST-voice_inter-conver__entry__30}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 17. Antwortkopfzeilen]
### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#vir-POST-voice_inter-conver__entry__34}{#vir-POST-voice_inter-conver__entry-200-status-code}{#vir-POST-voice_inter-conver__entry-500-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Falsch formatiertes JSON oder erforderliche Parameter wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 18. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#vir-POST-voice_inter-conver__entry__42}
| Name | Beschreibung |
|-|-|
| conversationId | Sys_id des neu erstellten Konversationsdatensatzes. Befindet sich in der Konversationstabelle \[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 -- POST /cs/voice-interactions/{interactionId}/messages {#ariaid-title5}
Fügt die angegebenen Sprachkonversationsnachrichten dem angegebenen Sprachtransaktionsdatensatz 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 Echtzeittransskription des Anrufs mehrmals aufrufen oder alle Nachrichten in einem einzigen Anruf übergeben, wenn Sie den Anruf zu Verlaufszwecken transkribieren. Wenn Sie eine Echtzeitkonversation verarbeiten, sollten Sie diesen Endpunkt häufig aufrufen, damit die Nachrichten rechtzeitig in Mitarbeiterbereich angezeigt werden. Nachrichten werden basierend auf ihrer Start- und Endzeit im Verhältnis zum Beginn des Anrufs sortiert.
### URL-Format
URL mit Versionsnummer: /api/now/{api_version}/cs/voice-interactions/{interactionId}/messages
Standard-URL: /api/now/v1/cs/voice-interactions/{interactionId}/messages
### Unterstützte Anforderungsparameter
{#vir-POST-voice_inter-messages__entry__2}{#vir-POST-voice_inter-messages__version-RESTAPI}
| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 vom Endpunkt [Sprachinteraktionsressource -- POST /cs/voice-interactions](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-POST-voice_inter "Erstellt einen Sprachinteraktionsdatensatz in der Interaktionstabelle [interaction].") zurückgegeben und in der Interaktionstabelle \[interaction\] gespeichert. Datentyp: Zeichenfolge |
[Tabelle : 19. Pfadparameter]
{#vir-POST-voice_inter-messages__entry__8}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 20. Abfrageparameter]
{#vir-POST-voice_inter-messages__entry__12}
| Name | Beschreibung |
|-|-|
| \ | Liste der Nachrichten, die an die angegebene Sprachinteraktion angehängt werden sollen. "":[ { "attributes": [Array], "beginOffsetMillis": Long, "content": "String" "endOffsetMillis": Long, "id": "String", "isEvent": Boolean, "isInternalMessage": Boolean, "loudnessScore": "Number", "participantId": "String", "sentiment": "String" } ] |
| \.Attribute | Schlüssel-Wert-Paare, die der Sprachinteraktion zugeordnet werden sollen. Dies kann jede Art von Datenobjekt sein, von einfachen Objekten bis zu komplexen zusammengesetzten Objekten. Sie werden beim Aufrufen von Amazon Web Services-APIs als eindeutige Bezeichner verwendet. Datentyp: Array von Objekten Standard: Keine |
| \.beginOffsetMillis | Erforderlich Zeitversatz zwischen dem Start der Sprachinteraktion und dem Start der zugehörigen Nachricht. Beispiel: „beginOffsetMillis": 2650. Datentyp: lang Einheit: Millisekunden |
| \.Inhalt | Erforderlich Text der Nachricht, die der Sprachinteraktion hinzugefügt werden soll. Datentyp: Zeichenfolge |
| \.endOffsetMillis | Erforderlich Zeitversatz zwischen dem Start der Sprachinteraktion und dem Ende der Nachricht. Beispiel: „endOffsetMillis": 9380. Datentyp: lang Einheit: Millisekunden |
| \.id | Nachrichten-UUID der Quelle dieser Sprachkonversation, z. B. für AmazonConnect. Legt den Wert der ID-Spalte der Quellnachricht fest. Datentyp: Zeichenfolge Standard: Keine |
| \.istEreignis | Wird 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: Boolesch Standardwert: false |
| \.istInternalMessage | Kennzeichnung, die angibt, ob es sich um eine interne Nachricht handelt und dem Anrufer nicht angezeigt werden sollte. Transkriptionen werden normalerweise als interne Nachrichten betrachtet und nur für den Service Desk-Mitarbeiter angezeigt, nicht für den Anrufer. Darüber hinaus wird die Flüsterfunktion verwendet, wenn eine stille Drittpartei ohne Wissen des Anrufers mit einer Person chattet oder in ein Telefongespräch einbezogen wird und einem Service Desk-Mitarbeiter einen Rat gibt. Der Anrufer kann diese Nachrichten nicht hören oder sehen, der Service Desk-Mitarbeiter hingegen schon. Gültige Werte: * true: Interne Nachricht, dem Anrufer nicht angezeigt. * false: Keine interne Nachricht, wird dem Anrufer angezeigt. {#vir-POST-voice_inter-messages__ul_sdw_bf3_vvb} Datentyp: Boolesch Standardwert: false |
| \.lautstärkePunktzahl | Messung, wie laut ein Kunde oder Service Desk-Mitarbeiter während eines Anrufs spricht. Contact Objektiv zeigt eine Analyse der Konversation an, die zeigt, wo sich die Person möglicherweise lautstark unterhält und eine negative Stimmung hat. Datentyp: Zahl Bereich: -1,0 (negativ) bis 1,0 (positiv) Standard: Null |
| \.Teilnehmer-ID | Erforderlich. Teilnehmer, der der Nachricht zugeordnet ist. Gültige Werte: * KUNDE * Agent Datentyp: Zeichenfolge |
| \.Stimmung | Stimmung der Nachricht. Dieser Wert wird von einem Drittanbieter generiert. Basierend auf den Konfigurationseinstellungen der Instanz ServiceNow wird dieser Wert dann entweder als positiv, negativ oder neutral übersetzt und im Konversations- und Interaktionsdatensatz gespeichert. Gültige Werte: * NEGATIV * NEUTRAL * POSITIV Datentyp: Zeichenfolge Standard: Null |
[Tabelle : 21. Parameter des Anforderungstexts (Amazon Connect)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#vir-POST-voice_inter-messages__entry__36}{#vir-POST-voice_inter-messages__accept-RESTAPI}{#vir-POST-voice_inter-messages__content_type-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 22. Anforderungskopfzeilen]
{#vir-POST-voice_inter-messages__entry__42}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 23. Antwortkopfzeilen]
### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#vir-POST-voice_inter-messages__entry__46}{#vir-POST-voice_inter-messages__entry-200-status-code}{#vir-POST-voice_inter-messages__entry-500-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Falsch formatiertes JSON oder erforderliche Parameter wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 24. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#vir-POST-voice_inter-messages__entry__54}
| Name | Beschreibung |
|-|-|
| Ergebnis | Nachricht, welche die Ergebnisse des Anrufs beschreibt. Datentyp: Zeichenfolge |
| Konversations-ID | Sys_id des erstellten Datensatzes der Sprachinteraktionsnachricht. Befindet sich in der Tabelle „Transkript-Konversationsnachricht für Sprachfunktionen" \[sys_cs_message_voice_transcript\]. Datentyp: Zeichenfolge |
[ ]
### 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-interactions/transcript {#ariaid-title6}
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
URL mit Versionsnummer: /api/now/{api_version}/cs/voice-interactions/{interactionId}/transcript
Standard-URL: /api/now/v1/cs/voice-interactions/{interactionId}/transcript
### Unterstützte Anforderungsparameter
{#vir-POST-voice_inter-transcript__entry__2}{#vir-POST-voice_inter-transcript__version-RESTAPI}
| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 25. Pfadparameter]
{#vir-POST-voice_inter-transcript__entry__6}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 26. Abfrageparameter]
{#vir-POST-voice_inter-transcript__entry__10}{#vir-POST-voice_inter-transcript__vto-interactionId-REST-entry}
| Name | Beschreibung |
|-|-|
| Konversation gestartet | Startzeit der Konversation. Befindet sich in der Interaktionstabelle \[interaction\]. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:MM:SS |
| interactionId | Sys_id des Interaktionsdatensatzes, dem die angegebenen Nachrichten hinzugefügt werden sollen. Dieser Wert wird vom Endpunkt [Sprachinteraktionsressource -- POST /cs/voice-interactions](https://www.servicenow.com/docs/c6do7fTcNuXTuIjDulMPmg#vir-POST-voice_inter "Erstellt einen Sprachinteraktionsdatensatz in der Interaktionstabelle [interaction].") zurückgegeben und in der Interaktionstabelle \[interaction\] gespeichert. Datentyp: Zeichenfolge |
| Quelle | Name des Kanals, der das Transkript der Konversationsinteraktion ursprünglich erstellt hat. Derzeit wird als einziger Wert `„Amazon Connect"`unterstützt. Datentyp: Zeichenfolge |
| Transkript | 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 |
| transcript.attributes | Schlüssel-Wert-Paare, die der Sprachinteraktion zugeordnet werden sollen. Dies kann jede Art von Datenobjekt sein, von einfachen Objekten bis zu komplexen zusammengesetzten Objekten. Sie werden beim Aufrufen von Amazon Web Services-APIs als eindeutige Bezeichner verwendet. Datentyp: Array von Objekten Standard: Keine |
| transcript.beginOffsetMillis | Erforderlich Zeitversatz zwischen dem Start der Sprachinteraktion und dem Start der zugehörigen Nachricht. Beispiel: „beginOffsetMillis": 2650. Datentyp: lang Einheit: Millisekunden |
| transcript.content | Erforderlich Text der Nachricht, die der Sprachinteraktion hinzugefügt werden soll. Datentyp: Zeichenfolge |
| transcript.endOffsetMillis | Erforderlich Zeitversatz zwischen dem Start 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 Wert der ID-Spalte der Quellnachricht fest. Datentyp: Zeichenfolge Standard: Keine |
| transcript.isEvent | Wird 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: Boolesch Standardwert: false |
| transcript.isInterneNachricht | Kennzeichnung, die angibt, ob es sich um eine interne Nachricht handelt und dem Anrufer nicht angezeigt werden sollte. Transkriptionen werden normalerweise als interne Nachrichten betrachtet und nur für den Service Desk-Mitarbeiter angezeigt, nicht für den Anrufer. Darüber hinaus wird die Flüsterfunktion verwendet, wenn eine stille Drittpartei ohne Wissen des Anrufers mit einer Person chattet oder in ein Telefongespräch einbezogen wird und einem Service Desk-Mitarbeiter einen Rat gibt. Der Anrufer kann diese Nachrichten nicht hören oder sehen, der Service Desk-Mitarbeiter hingegen schon. Gültige Werte: * true: Interne Nachricht, dem Anrufer nicht angezeigt. * false: Keine interne Nachricht, wird dem Anrufer angezeigt. {#vir-POST-voice_inter-transcript__ul_sdw_bf3_vvb} Datentyp: Boolesch Standardwert: false |
| transcript.voludnessScore | Messung, wie laut ein Kunde oder Service Desk-Mitarbeiter während eines Anrufs spricht. Contact Objektiv zeigt eine Analyse der Konversation an, die zeigt, wo sich die Person möglicherweise lautstark unterhält und eine negative Stimmung hat. Datentyp: Zahl Bereich: -1,0 (negativ) bis 1,0 (positiv) Standard: Null |
| transcript.participantId | Erforderlich. Teilnehmer, der der Nachricht zugeordnet ist. Gültige Werte: * KUNDE * Agent Datentyp: Zeichenfolge |
| transcript.sentiment | Stimmung der Nachricht. Dieser Wert wird von einem Drittanbieter generiert. Basierend auf den Konfigurationseinstellungen der Instanz ServiceNow wird dieser Wert dann entweder als positiv, negativ oder neutral übersetzt und im Konversations- und Interaktionsdatensatz gespeichert. Gültige Werte: * NEGATIV * NEUTRAL * POSITIV Datentyp: Zeichenfolge Standard: Null |
[Tabelle : 27. Anforderungstextparameter (XML oder JSON)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#vir-POST-voice_inter-transcript__entry__40}{#vir-POST-voice_inter-transcript__accept-RESTAPI}{#vir-POST-voice_inter-transcript__content_type-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 28. Anforderungskopfzeilen]
{#vir-POST-voice_inter-transcript__entry__46}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 29. Antwortkopfzeilen]
### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#vir-POST-voice_inter-transcript__entry__50}{#vir-POST-voice_inter-transcript__entry-200-status-code}{#vir-POST-voice_inter-transcript__entry-500-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Falsch formatiertes JSON oder erforderliche Parameter wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 30. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#vir-POST-voice_inter-transcript__entry__58}
| Name | Beschreibung |
|-|-|
| Ergebnis | Nachricht, welche die Ergebnisse des Anrufs beschreibt. Datentyp: Zeichenfolge |
| Konversations-ID | Sys_id der Sprachkonversationstabelle, an die die Nachrichten angehängt wurden. Befindet sich in der Konversationstabelle \[sys_cs_message_conversation\]. Datentyp: Zeichenfolge |
[ ]
### 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"
}