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.

Tableau 1. Propriétés de l'objet de charge utile du webhook CDR
Propriété	Type	Description
`primary_phone_number`	chaîne	Numéro de téléphone appelé.
`global_session_id`	chaîne	Identifiant unique de la session.
`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 requête SIP initiale `INVITE`. Les en-têtes d'identification d'appel de liaison SIP suivants sont pris en charge : \n - `X-Twilio-CallSid` \n - `X-SID` \n - `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 concernant les interactions avec l'assistant IA qui ont eu lieu pendant 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.

Tableau 2. Propriétés de l'objet d'appel
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 pour laquelle l'appel s'est terminé. Les raisons possibles sont les suivantes : \n - assistant_transfer \n - assistant_hangup \n - caller_hangup \n - 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.

Tableau 3. Propriétés de l'objet session_initiation_protocol
Propriété	Type	Description
`invite_arrival_timestamp`	Chaîne	Heure à laquelle la requête `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 requête SIP initiale `INVITE` et la réception de la requête SIP finale `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.

Tableau 4. Propriétés de l'objet assistant_interaction_summaries
Propriété	Type	Description
`assistant_id`	Chaîne	Identifiant unique de l 'assistant IA.
`session_id`	Chaîne	Identifiant unique de la session.
`turns`	Tableau	Un tableau d'objets décrivant les interactions de l'assistant IA qui ont eu lieu au cours de la conversation. Voir [`assistant_interaction_summaries.turns[]`](#cdr-log-reference-turns).

assistant_interaction_summaries.turns[]

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

Tableau 5. Propriétés des objets du tableau ` assistant_interaction_summaries.turns []`
Propriété	Type	Description
`assistant.log_id`	Chaîne	Identifiant unique pour l'événement enregistré, 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 requête a été envoyée à l 'assistant IA, 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 requête envoyée à l 'assistant IA. Voir [`assistant_interaction_summaries.turns[].request`](#cdr-log-reference-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.

Tableau 6. Propriétés de l'objet ` assistant_interaction_summaries.turns [].request`
Propriété	Type	Description
`type`	Chaîne	Type de requête : \n - `start`: une requête initiale est envoyée à l 'assistant IA \n - `speech_to_text`: une entrée est reçue du service Speech to Text \n - `dtmf`: la collecte des signaux DTMF est terminée \n - `sms`: un SMS est reçu de l'appelant \n - `post_response_timeout` : le délai de réponse post-appel expire \n - `redirect`: un appel est redirigé \n - `transfer`: un appel est transféré \n - `transfer_failed`: un transfert d'appel échoue \n - `final_utterance_timeout`: le délai de l'énoncé final expire \n - `no_input_turn`: `no input turn` est activé \n - `sms_failure`: un SMS ne peut pas être envoyé à l'appelant \n - `speech_to_text_result_filtered`: un énoncé est filtré en raison d'un faible niveau de confiance \n - `mrcp_recognition_unsuccessful`: la reconnaissance MRCP s'achève sans énoncé final \n - `network_warning`: une erreur réseau est détectée \n - `media_capability_change`: les capacités multimédias changent pendant un appel.
`streaming_statistics`	Objet	Informations et statistiques relatives à la reconnaissance de l' Speech to Text. Voir [`assistant_interaction_summaries.turns[].request.streaming_statistics`](#cdr-log-reference-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.

Tableau 7. Propriétés de l'objet ` assistant_interaction_summaries.turns [].streaming_statistics`
Propriété	Type	Description
`transaction_id`	Chaîne	Identifiant unique de la transaction.
`start_timestamp`	Chaîne	Heure à laquelle la transaction a commencé, 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 délai (en millisecondes) entre le moment où un silence est détecté dans la parole de l'appelant et la réception du résultat final de l 'assistant IA.
`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.

Tableau 8. Propriétés de l'objet ` assistant_interaction_summaries.turns [].response`
Propriété	Type	Description
`type`	Chaîne	Type de réponse : \n - `text_to_speech`: commande permettant de diffuser un message vocal à l'appelant \n - `sms` : commande permettant d'envoyer un SMS à l'appelant \n - `url`: commande permettant de diffuser un fichier audio à l'appelant \n - `transfer`: commande permettant de transférer un appel \n - `text_to_speech_config`: commande permettant de modifier les paramètres de l' Text to Speech \n - `speech_to_text_config`: commande permettant de modifier les paramètres de l' Speech to Text \n - `pause_speech_to_text`: commande permettant d'arrêter la reconnaissance vocale \n - `unpause_speech_to_text`: commande permettant de démarrer la reconnaissance vocale \n - `pause_dtmf`: commande permettant d'arrêter le traitement des signaux DTMF entrants \n - `unpause_dtmf`: unpause_dtmf : commande permettant de démarrer le traitement des signaux DTMF entrants \n - `enable_speech_barge_in`: commande permettant d'activer l'interruption vocale afin que les appelants puissent interrompre la lecture en parlant \n - `disable_speech_barge_in`: commande permettant de désactiver l'interruption vocale afin que la lecture ne soit pas interrompue lorsque les appelants parlent pendant la lecture audio \n - `enable_dtmf_barge_in`: commande permettant d'activer l'interruption DTMF afin que les appelants puissent interrompre la lecture depuis l'intégration téléphonique en appuyant sur une touche \n - `disable_dtmf_barge_in`: commande permettant de désactiver l'interruption DTMF afin que la lecture depuis l'intégration téléphonique ne soit pas interrompue lorsque l'appelant appuie sur une touche \n - `dtmf`: une commande permettant d'envoyer des signaux DTMF à l'appelant \n - `hangup`: une commande permettant de mettre fin à l'appel \n Voir Correspondance entre les types de réponse du CDR et de l'assistant IA.
`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 d' Text to Speech s. Voir [`assistant_interaction_summaries.turns[].response.streaming_statistics`](#cdr-log-reference-response-streaming_statistics).

Correspondance entre les types de CDR et les types de réponses de l'assistant IA

Les valeurs de la type propriété correspondent aux types de réponses de l'assistant IA.


Type de réponse de l'enregistrement de détail d'appel (CDR)	Type de réponse de l'assistant IA
`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.

Tableau 9. Propriétés de l'objet ` assistant_interaction_summaries.turns []` response.streaming_statistics
Propriété	Type	Description
`transaction_id`	Chaîne	Identifiant unique de la transaction.
`start_timestamp`	Chaîne	Heure à laquelle la transaction a commencé, 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 le moment où une commande vocale est envoyée à l 'assistant IA et celui où l'intégration téléphonique reçoit le premier paquet de données audio synthétisées.

`warnings_and_errors`

L'objet warnings_and_errors contient les avertissements et les erreurs qui ont été enregistrés au cours de l'appel et qui sont énuméré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 les sous-débitages, c'est-à-dire lorsque la synthèse d' Text to Speech s ne parvient pas à suivre le débit de transmission de l'intégration du téléphone, ce qui peut entraîner des sauts audio.
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.

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

`max_response_milliseconds`

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

Tableau 11. Propriétés de l'objet max_response_milliseconds
Propriété	Type	Description
`assistant`	Nombre	Latence aller-retour maximale (en millisecondes), calculée à partir de toutes les requêtes adressées à l'assistant IA dans le cadre de l'appel.
`text_to_speech`	Nombre	Durée maximale (en millisecondes) entre le moment où une phrase est envoyée au service Text to Speech et celui où l'intégration téléphonique reçoit le premier paquet de données audio synthétisées. Cette valeur est calculée à partir de toutes les requêtes « Text to Speech » liées à l'appel.
`speech_to_text`	Nombre	Latence maximale (en millisecondes) entre le moment où un silence est détecté dans la voix de l'appelant et celui où le résultat final du service Speech to Text est reçu. Cette valeur est calculée à partir de tous les résultats de reconnaissance de l' Speech to Text s liés à l'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.

Tableau 12. 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/` .