Référence des événements du journal CDR

Pour les événements cdr_logged envoyés par un webhook de journal, l'objet payload contient des données relatives à un événement CDR (enregistrement de détail d'appel) géré par l'intégration téléphonique. L'objet payload d'un événement CDR contient les propriétés suivantes.

Propriétés de l'objet de contenu du webhook CDR
Propriété Type Description
primary_phone_number chaîne Numéro de téléphone appelé.
global_session_id chaîne Identificateur de session unique.
failure_occurred booléen Indique si un incident s'est produit lors de l'appel.
failure_details chaîne Détails sur tout incident qui s'est produit.
transfer_occurred booléen Indique si une tentative de transfert d'un appel a été effectuée.
active_calls Nombre Nombre d'appels actifs lors du démarrage de l'appel.
x-global-sip-trunk-call-id chaîne

Valeur de l'en-tête SIP trunk call ID extraite de la demande initiale SIP INVITE. Les en-têtes d'ID d'appel de liaison SIP suivants sont pris en charge :

  • X-Twilio-CallSid
  • X-SID
  • X-Global-SIP-Trunk-Call-ID
call Objet Informations sur l'appel. Voir call.
session_initiation_protocol Objet Détails relatifs au protocole SIP. Voir session_initiation_protocol.
max_response_milliseconds Objet Temps d'attente maximal pour les services utilisés lors de l'appel. Voir max_response_milliseconds.
assistant_interaction_summaries Tableau Détails sur les interactions watsonx Assistant qui ont eu lieu lors de l'appel. Voir assistant_interaction_summaries.
injected_custom_data Objet Un ensemble de paires clé/valeur extraites de la variable contextuelle cdr_custom_data.
warnings_and_errors Tableau Avertissements ou erreurs enregistrés pendant l'appel. Voir warnings_and_errors.
realtime_transport_network_summary Objet Statistiques du flux entrant dans l'objet inbound_stream et statistiques pour le flux sortant dans l'objet outbound_stream. Inclus uniquement si RTCP est activé. Voir realtime_transport_network_summary.

call

L'objet call contient les propriétés suivantes.

Propriétés de l'objet call
Propriété Type Description
start_timestamp Chaîne Heure à laquelle l'appel a commencé, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
stop_timestamp Chaîne Heure à laquelle l'appel s'est terminé, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
milliseconds_elapsed Nombre Durée de l'appel, en millisecondes.
end_reason chaîne Raison de la fin de l'appel. Les raisons possibles sont les suivantes:
-assistant_transfer
-assistant_hangup
-caller_hangup
-failed
security.media_encrypted Booléen Indique si le média a été chiffré.
security.signaling_encrypted Booléen Indique si la notification SIP a été chiffrée.
security.sip_authenticated Booléen Indique si l'authentification SIP a été utilisée pour authentifier l'appelant.

session_initiation_protocol

L'objet session_initiation_protocol contient les propriétés suivantes.

Propriétés de l'objet session_initiation_protocol
Propriété Type Description
invite_arrival_timestamp Chaîne Heure à laquelle la demande INVITE est arrivée, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
setup_milliseconds Nombre Temps nécessaire à l'établissement de l'appel, en millisecondes. Le temps écoulé entre la réception de la demande initiale SIP INVITE et la réception de la demande finale SIP ACK.
headers.call_id Chaîne Champ d'en-tête SIP Call-ID extrait du SIP INVITE relatif à l'appel.
headers.from_uri Chaîne URI SIP de l'en-tête initial SIP INVITE From.
headers.to_uri Chaîne URI SIP de l'en-tête initial SIP INVITE To.

assistant_interaction_summaries

L'objet assistant_interaction_summaries contient les propriétés suivantes.

Propriétés de l'objet assistant_interaction_Récapitulatifs
Propriété Type Description
assistant_id Chaîne Identifiant unique de l'assistant.
session_id Chaîne Identifiant unique de la session.
turns Tableau Un tableau d'objets décrivant les interactions watsonx Assistant qui ont eu lieu pendant la conversation. Voir assistant_interaction_summaries.turns[].

assistant_interaction_summaries.turns[]

Les objets du tableau assistant_interaction_summaries.turns contiennent les propriétés suivantes.

Propriétés des objets dans assistant_interaction_summaries.tours[] array caption-side
Propriété Type Description
assistant.log_id Chaîne Identificateur unique de l'événement consigné, qui peut être utilisé pour établir une corrélation entre les journaux de messages et les événements CDR.
assistant.start_timestamp Chaîne Heure à laquelle la demande a été envoyée à l'assistant, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
assistant.response_milliseconds Nombre Temps (en millisecondes) entre l'envoi de la demande et la réception de la réponse de l'assistant.
request Objet Une demande envoyée à l'assistant. Voir assistant_interaction_summaries.turns[].request.
response Tableau Un tableau des objets response associés à la demande.

assistant_interaction_summaries.turns[].request

L'objet assistant_interaction_summaries.turns[].request contient les propriétés suivantes.

Propriétés de l'objet assistant_interaction_summaries.tours[].request caption-side
Propriété Type Description
type Chaîne

Type de demande:

  • start: une demande initiale est envoyée à l'assistant
  • speech_to_text: l'entrée est reçue du service Speech to Text
  • dtmf: la collecte DTMF est terminée
  • sms: un message SMS est reçu de l'appelant
  • post_response_timeout: le temporisateur de post-réponse expire
  • redirect: un appel est redirigé
  • transfer: un appel est transféré
  • transfer_failed: un transfert d'appel échoue
  • final_utterance_timeout: le temporisateur d'énoncé final expire
  • no_input_turn: no input turn est activé
  • sms_failure: un message SMS ne peut pas être envoyé à l'appelant
  • speech_to_text_result_filtered: un énoncé est filtré en raison d'un niveau de confiance faible
  • mrcp_recognition_unsuccessful: la reconnaissance MRCP se termine sans énoncé final
  • network_warning: une erreur réseau est détectée
  • media_capability_change: modification des fonctions de support lors d'un appel.
streaming_statistics Objet Informations et statistiques relatives à la reconnaissance Speech to Text. Voir assistant_interaction_summaries.turns[].request.streaming_statistics.
assistant_interaction_summaries.turns[].request.streaming_statistics

L'objet assistant_interaction_summaries.turns[].request.streaming_statistics contient les propriétés suivantes.

Propriétés de l'objet assistant_interaction_summaries.tours[].streaming_statistics caption-side
Propriété Type Description
transaction_id Chaîne Identifiant unique de la transaction.
start_timestamp Chaîne Heure de début de la transaction, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
stop_timestamp Chaîne Heure de fin de la transaction, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
response_milliseconds Nombre Le temps d'attente (en millisecondes) entre la détection d'un silence dans la parole de l'appelant et la réception d'un résultat final de l'assistant.
echo_detected Booléen Indique si un écho a été détecté.
confidence Nombre Score de confiance de l'énoncé final.

assistant_interaction_summaries.turns[].response

L'objet assistant_interaction_summaries.turns[].response contient les propriétés suivantes.

Propriétés de l'objet assistant_interaction_summaries.tours[].response caption-side
Propriété Type Description
type Chaîne

Type de réponse :

  • text_to_speech: commande de lecture d'un énoncé à l'appelant
  • sms: commande d'envoi d'un message SMS à l'appelant
  • url: commande de lecture d'un fichier audio à l'appelant
  • transfer: commande de transfert d'un appel
  • text_to_speech_config: commande de modification des paramètres de Text to Speech
  • speech_to_text_config: commande de modification des paramètres de Speech to Text
  • pause_speech_to_text: une commande pour arrêter la reconnaissance vocale
  • unpause_speech_to_text: une commande pour démarrer la reconnaissance vocale
  • pause_dtmf: une commande pour arrêter le traitement des signaux DTMF entrants
  • unpause_dtmf: unpause_dtmf : une commande pour démarrer le traitement des signaux DTMF entrants
  • enable_speech_barge_in: une commande pour activer l'intrusion vocale afin que les appelants puissent interrompre la lecture en parlant
  • disable_speech_barge_in: une commande pour désactiver l'insertion vocale afin que la lecture ne soit pas interrompue lorsque les appelants parlent pendant la lecture audio
  • enable_dtmf_barge_in: une commande pour activer l'insertion DTMF afin que les appelants puissent interrompre la lecture à partir de l'intégration téléphonique en appuyant sur une touche
  • disable_dtmf_barge_in: une commande pour désactiver l'insertion DTMF afin que la lecture de l'intégration téléphonique ne soit pas interrompue lorsque l'appelant appuie sur une touche
  • dtmf: une commande pour envoyer des signaux DTMF à l'appelant
  • hangup: une commande pour déconnecter l'appel
    Voir Mappage entre les types de réponses CDR et watsonx Assistant.
barge_in_occurred Booléen Indique si la barge s'est produite pendant le virage.
streaming_statistics Objet Informations et statistiques relatives à la synthèse et à la lecture de Text to Speech. Voir assistant_interaction_summaries.turns[].response.streaming_statistics.
Mappage entre le CDR et les types de réponse watsonx Assistant

Les valeurs de la propriété type correspondent aux types de réponses watsonx Assistant.

Type de réponse de l'enregistrement de détail d'appel (CDR) Type de réponse watsonx Assistant
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

L'objet assistant_interaction_summaries.turns[].response.streaming_statistics contient les propriétés suivantes.

Propriétés de l'objet assistant_interaction_summaries.tours[].response.streaming_statistics caption-side
Propriété Type Description
transaction_id Chaîne Identifiant unique de la transaction.
start_timestamp Chaîne Heure de début de la transaction, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
stop_timestamp Chaîne Heure de fin de la transaction, au format ISO (yyyy-MM-ddTHH:mm:ss.SSSZ).
response_milliseconds Nombre Temps (en millisecondes) entre l'envoi d'un texte à l'assistant et la réception par l'intégration téléphonique du premier paquet de sons synthétisés.

warnings_and_errors

L'objet warnings_and_errors contient les avertissements et les erreurs qui ont été enregistrés lors de l'appel et qui sont répertoriés par ordre d'occurrence. Les avertissements relatifs aux conditions suivantes sont inclus.

  • Les messages lorsque les déclarations sont filtrées par le seuil de score de confiance.
  • Text to Speech déborde, c'est-à-faire lorsque la synthèse Text to Speech ne peut pas suivre le débit d'intégration du téléphone et que l'audio peut sauter.
  • Avertissements réseau RTP, tels que la perte de paquets élevée ou la gigue moyen élevé, si RTCP est activé.

L'exemple suivant illustre la structure de l'objet 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"
    }
  ]

L'objet de chaque avertissement contient les propriétés suivantes.

Propriétés de l'objet warnings_and_errors
Propriété Type Description
message Chaîne Texte du message d'avertissement.
id Chaîne Identificateur de message unique.

max_response_milliseconds

L'objet max_response_milliseconds contient les propriétés suivantes.

Propriétés de l'objet max_response_milliseconds
Propriété Type Description
assistant Nombre Temps d'attente maximal (en millisecondes), calculé à partir de toutes les demandes watsonx Assistant liées à l'appel.
text_to_speech Nombre Temps maximum (en millisecondes) entre le moment où un texte est envoyé au service Text to Speech et le moment où l'intégration téléphonique reçoit le premier paquet d'audio synthétisé. Cette valeur est calculée à partir de toutes les demandes Text to Speech liées à l'appel.
speech_to_text Nombre Temps de latence maximal (en millisecondes) entre la détection d'un silence dans la parole de l'appelant et la réception d'un résultat final du service Speech to Text. Cette valeur est calculée à partir de tous les résultats de reconnaissance Speech to Text liés à cet appel.

realtime_transport_network_summary

Lorsque RTCP est activé, l'objet realtime_transport_network_summary fournit des statistiques pour le flux entrant dans l'objet inbound_stream et des statistiques pour le flux sortant dans l'objet outbound_stream

L'exemple suivant montre la structure de l'objet 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"
   }
}

L'objet de chaque flux contient les propriétés suivantes.

Propriétés de l'objet realtime_transport_network_summary
Propriétés Type Description
maximum_jitter Nombre Gigue maximale pendant l'appel.
average_jitter Nombre Gigue moyenne calculée sur la durée de l'appel.
packets_lost Nombre Estimation du nombre de paquets perdus lors de l'appel.
packets_transmitted Nombre Estimation du nombre total de paquets transmis pendant l'appel.
canonical_name Chaîne Identifiant unique de l'expéditeur du flux, généralement au format @.
tool_name Chaîne Nom de l'application ou de l'outil d'où provient le flux. Pour l'intégration téléphonique, la valeur par défaut est IBM Voice Gateway/ .