Referenz zu CDR-Protokollereignissen

Bei Ereignissen des Typs cdr_logged, die von einem Protokoll-Webhook gesendet werden, enthält das Objekt payload Daten zu einem CDR-Ereignis (CDR = Call Detail Record), das von der Telefonintegration verarbeitet wurde. Das Objekt payload für ein CDR-Ereignis enthält die folgenden Eigenschaften:

Eigenschaften des CDR-Webhook-Nutzdatenobjekts
Eigenschaft	Typ	Beschreibung
`primary_phone_number`	Zeichenfolge	Rufnummer, die angerufen wurde.
`global_session_id`	Zeichenfolge	Eindeutige Sitzungs-ID.
`failure_occurred`	Boolesch	Gibt an, ob während des Anrufs ein Fehler aufgetreten ist.
`failure_details`	Zeichenfolge	Details zu allen aufgetretenen Fehlern.
`transfer_occurred`	Boolesch	Gibt an, ob versucht wurde, einen Anruf weiterzuleiten.
`active_calls`	Zahl	Die Anzahl der aktiven Anrufe beim Start des Anrufs.
`x-global-sip-trunk-call-id`	Zeichenfolge	Wert des SIP-Trunk-Call-ID-Headers, der aus der ursprünglichen SIP `INVITE`-Anfrage extrahiert wurde. Die folgenden Header der SIP-Trunk-Anruf-ID werden unterstützt: `X-Twilio-CallSid` `X-SID` `X-Global-SIP-Trunk-Call-ID`
`call`	Object	Informationen zu dem Anruf. Siehe `call`.
`session_initiation_protocol`	Object	Details zum SIP-Protokoll Siehe `session_initiation_protocol`.
`max_response_milliseconds`	Object	Maximale Latenzzeit für Services, die während des Anrufs verwendet werden. Siehe `max_response_milliseconds`.
`assistant_interaction_summaries`	Array	Details zu den watsonx Assistant-Interaktionen während des Anrufs. Siehe `assistant_interaction_summaries`.
`injected_custom_data`	Object	Eine Gruppe von Schlüssel/Wert-Paaren, die aus der Kontextvariablen `cdr_custom_data` extrahiert wurden.
`warnings_and_errors`	Array	Warnungen oder Fehler, die während des Anrufs protokolliert wurden. Siehe `warnings_and_errors`.
`realtime_transport_network_summary`	Object	Statistikdaten für den eingehenden Datenstrom im Objekt `inbound_stream` und Statistikdaten für den abgehenden Datenstrom im Objekt `outbound_stream` Nur eingeschlossen, wenn RTCP aktiviert ist. Siehe `realtime_transport_network_summary`.

`call`

Das Objekt call enthält die folgenden Eigenschaften.

Eigenschaften des Aufrufobjekts
Eigenschaft	Typ	Beschreibung
`start_timestamp`	Zeichenfolge	Uhrzeit des Gesprächsbeginns, im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`stop_timestamp`	Zeichenfolge	Uhrzeit, zu der der Anruf beendet wurde, im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`milliseconds_elapsed`	Zahl	Dauer des Anrufs, in Millisekunden.
`end_reason`	Zeichenfolge	Ursache für die Beendigung des Anrufs. Mögliche Ursachen: -assistant_transfer -assistant_hangup -caller_hangup -fehlgeschlagen
`security.media_encrypted`	Boolescher Wert	Gibt an, ob das Medium verschlüsselt wurde.
`security.signaling_encrypted`	Boolescher Wert	Gibt an, ob die SIP-Signalisierung verschlüsselt war.
`security.sip_authenticated`	Boolescher Wert	Gibt an, ob die SIP-Authentifizierung für die Authentifizierung des Anrufers verwendet wurde.

`session_initiation_protocol`

Das Objekt session_initiation_protocol enthält die folgenden Eigenschaften.

Eigenschaften des session_initiation_protocol-Objekts
Eigenschaft	Typ	Beschreibung
`invite_arrival_timestamp`	Zeichenfolge	Zeitpunkt, zu dem die `INVITE`-Anforderung eingegangen ist, im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`setup_milliseconds`	Zahl	Zeit, die zum Aufbau des Anrufs benötigt wurde, in Millisekunden. Die Zeit zwischen dem Eingang der ersten SIP `INVITE` Anfrage und dem Eingang der letzten SIP `ACK` Anfrage.
`headers.call_id`	Zeichenfolge	SIP `Call-ID` Header-Feld, das dem SIP `INVITE` für den Anruf entnommen wurde.
`headers.from_uri`	Zeichenfolge	SIP URI aus dem ursprünglichen SIP INVITE `From` Header.
`headers.to_uri`	Zeichenfolge	SIP URI aus dem ursprünglichen SIP INVITE `To` Header.

`assistant_interaction_summaries`

Das Objekt assistant_interaction_summaries enthält die folgenden Eigenschaften.

Eigenschaften des Objekts 'assistant_interaction_summaries'
Eigenschaft	Typ	Beschreibung
`assistant_id`	Zeichenfolge	Eindeutige Kennung des Assistenten.
`session_id`	Zeichenfolge	Eindeutiger Bezeichner der Sitzung.
`turns`	Array	Ein Array von Objekten, die die watsonx Assistant-Interaktionen beschreiben, die während des Dialogs stattgefunden haben. Siehe `assistant_interaction_summaries.turns[]`.

`assistant_interaction_summaries.turns[]`

Die Objekte im Array assistant_interaction_summaries.turns enthalten die folgenden Eigenschaften.

Eigenschaften der Objekte in assistant_interaction_summaries.turns[] array caption-side
Eigenschaft	Typ	Beschreibung
`assistant.log_id`	Zeichenfolge	Eindeutige Kennung für das protokollierte Ereignis, die zum Korrelieren zwischen Nachrichtenprotokollen und CDR-Ereignissen verwendet werden kann.
`assistant.start_timestamp`	Zeichenfolge	Uhrzeit, zu der die Anfrage an den Assistenten gesendet wurde, im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`assistant.response_milliseconds`	Zahl	Zeit (in Millisekunden) zwischen dem Senden der Anfrage und dem Empfang der Antwort vom Assistenten.
`request`	Object	Eine an den Assistenten gesendete Anforderung. Siehe `assistant_interaction_summaries.turns[].request`.
`response`	Array	Ein Array mit `response`-Objekten, die der Anforderung zugeordnet sind

`assistant_interaction_summaries.turns[].request`

Das Objekt assistant_interaction_summaries.turns[].request enthält die folgenden Eigenschaften.

Eigenschaften des Objekts assistant_interaction_summaries.turns[].request"
Eigenschaft	Typ	Beschreibung
`type`	Zeichenfolge	Anforderungstyp: `start`: Eine erste Anforderung wird an den Assistenten gesendet `speech_to_text`: Eingabe wird vom Service Speech to Text empfangen `dtmf`: DTMF-Erfassung abgeschlossen `sms`: Eine SMS-Nachricht wird vom Anrufer empfangen `post_response_timeout`: Der Zeitgeber nach der Antwort läuft ab `redirect`: Ein Anruf wird umgeleitet `transfer`: Ein Anruf wird weitergeleitet `transfer_failed`: Eine Anrufübergabe schlägt fehl `final_utterance_timeout`: Der Zeitgeber für endgültige Äußerung läuft ab `no_input_turn`: `no input turn` ist aktiviert `sms_failure`: Eine SMS-Nachricht kann nicht an den Anrufer gesendet werden `speech_to_text_result_filtered`: Eine Äußerung wird aufgrund eines niedrigen Konfidenzniveaus gefiltert `mrcp_recognition_unsuccessful`: Die MRCP-Erkennung wird ohne endgültige Äußerung abgeschlossen `network_warning`: Ein Netzfehler wird festgestellt `media_capability_change`: Medienfunktionalität ändert sich während eines Anrufs.
`streaming_statistics`	Object	Informationen und Statistiken, die sich auf die Speech to Text Anerkennung beziehen. Siehe `assistant_interaction_summaries.turns[].request.streaming_statistics`.

`assistant_interaction_summaries.turns[].request.streaming_statistics`

Das Objekt assistant_interaction_summaries.turns[].request.streaming_statistics enthält die folgenden Eigenschaften.

Eigenschaften des assistant_interaction_summaries.turns[].streaming_statistics-Objekts caption-side
Eigenschaft	Typ	Beschreibung
`transaction_id`	Zeichenfolge	Eindeutiger Bezeichner der Transaktion.
`start_timestamp`	Zeichenfolge	Uhrzeit des Beginns der Transaktion im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`stop_timestamp`	Zeichenfolge	Uhrzeit, zu der die Transaktion beendet wurde, im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`response_milliseconds`	Zahl	Die Latenzzeit (in Millisekunden) zwischen dem Zeitpunkt, zu dem das Schweigen in der Sprache des Anrufers erkannt wird, und dem Empfang eines Endergebnisses vom Assistenten.
`echo_detected`	Boolescher Wert	Gibt an, ob ein Echo erkannt wurde.
`confidence`	Zahl	Konfidenzwert der letzten Äußerung.

`assistant_interaction_summaries.turns[].response`

Das Objekt assistant_interaction_summaries.turns[].response enthält die folgenden Eigenschaften.

Eigenschaften des assistant_interaction_summaries.turns[].response-Objekts caption-side
Eigenschaft	Typ	Beschreibung
`type`	Zeichenfolge	Antworttyp: `text_to_speech`: ein Befehl zum Abspielen einer Äußerung an den Anrufer `sms`: ein Befehl zum Senden einer SMS-Nachricht an den Anrufer `url`: ein Befehl zum Abspielen einer Audiodatei an den Anrufer `transfer`: ein Befehl zum Weiterleiten eines Anrufs `text_to_speech_config`: ein Befehl zum Ändern der Text to Speech-Einstellungen `speech_to_text_config`: ein Befehl zum Ändern der Speech to Text-Einstellungen `pause_speech_to_text`: ein Befehl zum Stoppen der Spracherkennung `unpause_speech_to_text`: ein Befehl zum Starten der Spracherkennung `pause_dtmf`: ein Befehl zum Stoppen der Verarbeitung eingehender DTMF-Signale `unpause_dtmf`: unpause_dtmf: ein Befehl zum Starten der Verarbeitung eingehender DTMF-Signale `enable_speech_barge_in`: ein Befehl zum Aktivieren von Spracheinblendungen, damit Anrufer die Wiedergabe durch Sprechen unterbrechen können `disable_speech_barge_in`: ein Befehl zum Deaktivieren des Spracheinblendens, so dass die Wiedergabe nicht unterbrochen wird, wenn Anrufer während der Audiowiedergabe sprechen `enable_dtmf_barge_in`: ein Befehl zum Aktivieren des DTMF-Einblendens, so dass Anrufer die Wiedergabe von der Telefonintegration durch Drücken einer Taste unterbrechen können `disable_dtmf_barge_in`: ein Befehl zum Deaktivieren des DTMF-Barge-In, so dass die Wiedergabe von der Telefonintegration nicht unterbrochen wird, wenn der Anrufer eine Taste drückt `dtmf`: ein Befehl zum Senden von DTMF-Signalen an den Anrufer `hangup`: ein Befehl zum Trennen der Verbindung Siehe Zuordnung zwischen den Antworttypen CDR und watsonx Assistant.
`barge_in_occurred`	Boolescher Wert	Gibt an, ob während des Turnus ein Einsprechen aufgetreten ist.
`streaming_statistics`	Object	Informationen und Statistiken, die sich auf die Synthese und Wiedergabe von Text to Speech beziehen. Siehe `assistant_interaction_summaries.turns[].response.streaming_statistics`.

Zuordnung zwischen Antworttypen von CDR und watsonx Assistant

Die Werte der Eigenschaft type entsprechen den Antworttypen von watsonx Assistant.

CDR-Antworttyp	watsonx Assistant-Antworttyp
`text_to_speech`	`text`
`url`	`audio`
`dtmf`	`dtmf`, `command_info.type` : `send`
`sms`	`user_defined`, `vgwAction.command` : `vgwActSendSMS`
`transfer`	`connect_to_agent`
`text_to_speech_config`	`text_to_speech`, `command_info.type` : `configure`
`speech_to_text_config`	`speech_to_text`, `command_info.type` : `configure`
`unpause_speech_to_text`	`start_activities`, `type`:`speech_to_text_recognition`
`pause_speech_to_text`	`stop_activities`, `type`:`speech_to_text_recognition`
`unpause_dtmf`	`start_activities`, `type`:`dtmf_collection`
`pause_dtmf`	`stop_activities`, `type`:`dtmf_collection`
`enable_speech_barge_in`	`text_to_speech`, `command_info.type` : `enable_barge_in`
`disable_speech_barge_in`	`text_to_speech`, `command_info.type` : `disable_barge_in`
`enable_dtmf_barge_in`	`dtmf`, `command_info.type` : `enable_barge_in`
`disable_dtmf_barge_in`	`dtmf`, `command_info.type` : `disable_barge_in`
`hangup`	`end_session`

`assistant_interaction_summaries.turns[].response.streaming_statistics`

Das Objekt assistant_interaction_summaries.turns[].response.streaming_statistics enthält die folgenden Eigenschaften.

Eigenschaften des Objekts assistant_interaction_summaries.turns[].response.streaming_statistics"
Eigenschaft	Typ	Beschreibung
`transaction_id`	Zeichenfolge	Eindeutiger Bezeichner der Transaktion.
`start_timestamp`	Zeichenfolge	Uhrzeit des Beginns der Transaktion im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`stop_timestamp`	Zeichenfolge	Uhrzeit, zu der die Transaktion beendet wurde, im ISO-Format (`yyyy-MM-ddTHH:mm:ss.SSSZ`).
`response_milliseconds`	Zahl	Zeit (in Millisekunden) zwischen dem Senden einer Textäußerung an den Assistenten und dem Empfang des ersten synthetisierten Audiopakets durch die Telefonintegration.

`warnings_and_errors`

Das Objekt warnings_and_errors enthält Warnungen und Fehler, die während des Aufrufs protokolliert wurden und die in der Reihenfolge ihres Auftretens aufgelistet sind. Es sind Warnhinweise für die folgenden Bedingungen enthalten.

Nachrichten, wenn Äußerungen durch den Schwellenwert für den Verlässlichkeitsscore herausgefiltert werden.
Text to Speech-Underflows, d. h., wenn die Text to Speech-Synthese nicht mit der Streaming-Rate der Telefonintegration Schritt halten kann und die Audiodaten möglicherweise übersprungen werden.
RTP-Netzwerkwarnungen, z. B. hoher Paketverlust oder hoher durchschnittlicher Jitter, wenn RTCP aktiviert ist.

Das folgende Beispiel zeigt die Struktur des Objekts warnings_and_errors:

  "warnings_and_errors": [
    {
      "message": "CWSMR0032W: A Watson Speech to Text final utterance has a confidence score of 0.1, which does not meet the confidence score threshold of 0.2. The utterance will be ignored.",
      "id": "CWSMR0032W"
    },
    {
      "message": "CWSMR0031W: The synthesis stream from the Watson Text-to-Speech service can't keep up with the playback rate to the caller, so audio might skip. transaction ID=a1b2c3d4e5",
      "id": "CWSMR0031W"
    }
  ]

Das Objekt für jede Warnung enthält die folgenden Eigenschaften.

Eigenschaften des Objekts 'warnings_and_errors'
Eigenschaft	Typ	Beschreibung
`message`	Zeichenfolge	Text der Warnmeldung.
`id`	Zeichenfolge	Eindeutige Nachrichten-ID.

`max_response_milliseconds`

Das Objekt max_response_milliseconds enthält die folgenden Eigenschaften.

Eigenschaften des Objekts 'max_response_milliseconds'
Eigenschaft	Typ	Beschreibung
`assistant`	Zahl	Maximale Round-Trip-Latenz (in Millisekunden), berechnet aus allen watsonx Assistant Anfragen, die sich auf den Anruf beziehen.
`text_to_speech`	Zahl	Maximale Zeit (in Millisekunden) zwischen dem Senden einer Textäußerung an den Dienst Text to Speech und dem Empfang des ersten synthetischen Audiopakets durch die Telefonintegration. Dieser Wert wird aus allen Text to Speech-Anforderungen im Zusammenhang mit dem Anruf berechnet.
`speech_to_text`	Zahl	Maximale Latenzzeit (in Millisekunden) zwischen der Erkennung von Stille in der Sprache des Anrufers und dem Empfang eines Endergebnisses vom Dienst Speech to Text. Dieser Wert wird aus allen Ergebnissen der Speech to Text-Erkennung im Zusammenhang mit dem Anruf berechnet.

`realtime_transport_network_summary`

Wenn RTCP aktiviert ist, stellt das Objekt realtime_transport_network_summary Statistiken für den eingehenden Datenstrom im Objekt inbound_stream und Statistiken für den ausgehenden Datenstrom im Objekt outbound_stream bereit.

Das folgende Beispiel zeigt die Struktur des Objekts realtime_transport_network_summary.

"realtime_transport_network_summary": {
  "inbound_stream": {
    "maximum_jitter": 5,
    "average_jitter": 1,
    "packets_lost": 0,
    "packets_transmitted": 1000,
    "canonical_name": "user@example.com",
    "tool_name": "User SIP Phone"
   },
  "outbound_stream": {
    "maximum_jitter": 5,
    "average_jitter": 1,
    "packets_lost": 0,
    "packets_transmitted": 2000,
    "canonical_name": "voice.gateway@127.0.0.1",
    "tool_name": "IBM Voice Gateway/1.0.0.5"
   }
}

Das Objekt für jeden Stream enthält die folgenden Eigenschaften.

Eigenschaften des Objekts realtime_transport_network_summary
Eigenschaften	Typ	Beschreibung
`maximum_jitter`	Zahl	Maximaler Jitter während des Anrufs.
`average_jitter`	Zahl	Durchschnittlicher Jitter, berechnet über die Dauer des Anrufs.
`packets_lost`	Zahl	Eine Schätzung der Anzahl der Pakete, die während des Anrufs verloren gegangen sind.
`packets_transmitted`	Zahl	Schätzung der Gesamtzahl der Pakete, die während des Anrufs übertragen wurden.
`canonical_name`	Zeichenfolge	Eindeutige Kennung für den Absender des Datenstroms, normalerweise im Format `@`.
`tool_name`	Zeichenfolge	Name der Anwendung oder des Tools, von der/dem der Stream stammt. Für die Telefonintegration ist der Standardwert `IBM Voice Gateway/` .