Pubblicare eventi per gli assistenti virtuali

L'adattatore dell'agente può utilizzare l'API postMessage() del browser per inviare eventi all'iframe principale. Questi eventi possono essere utilizzati da JavaScript nell'iframe principale e per intraprendere varie azioni nell'implementazione CRM personalizzata. Per farlo, l'applicazione deve ascoltare l'evento MessageEvent nella finestra principale. In base agli eventi, l'applicazione può attivare azioni come l'apertura di una scheda ticket per un ID sessione specifico. Sia l'adattatore di chiamata sia l'adattatore di chat hanno eventi specifici che possono essere utilizzati per migliorare le funzionalità del CRM.

Contact Center AI Platform supporta i seguenti eventi dell'assistente virtuale per le attività:

  • Assistente virtuale per le attività che partecipa

  • Assistente virtuale per le attività rimanente

  • Variabili di sessione personalizzate dellƏassistente virtuale per le attività ricevute

Per un elenco completo degli eventi post correlati agli adattatori agenti, consulta Adattatori agenti.

Assistente virtuale per le attività che partecipa

Questo evento viene trasmesso quando l'assistente virtuale per le attività partecipa a una sessione.

Campi di dati

  • call_id. L'identificatore di una sessione vocale (IVR).

  • chat_id. L'identificatore di una sessione di chat web o mobile.

  • campaign_id: l'identificatore di una chiamata della campagna.

  • campaign_name: il nome della campagna.

  • virtual_agent_id: l'identificatore di un assistente virtuale per le attività.

  • virtual_agent_name: il nome dell'assistente virtuale.

  • participant_id: l'identificatore del partecipante per l'assistente virtuale per le attività.

  • queue_id: l'identificatore della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • queue_path: il percorso della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • queue_language_id: la lingua della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • session_type: il tipo di sessione, ad esempio messaggistica in entrata tramite chat web.

  • conversation_id: l'identificatore delle sessioni dell'agente virtuale che utilizzano profili di conversazione.

  • session_id: l'identificatore per le sessioni dell'agente virtuale che non utilizzano profili conversazione.

  • timestamp: la data e l'ora di un evento.

  • data_parameters: le variabili configurate nel portale CCAI Platform e inviate all'assistente virtuale per le attività.

Payload di esempio

{
 "type": "Task_VA_Joined",
 "data": {
   "chat_id": 103646,
   "campaign_id": 1432,// omitted if not available
   "campaign_name": "Survey Movie", // omitted if not available
   "virtual_agent_id": 1,
   "virtual_agent_name": "name",
   "participant_id": 1,
   "queue_id": 8469, // omitted if not available
   "queue_path": "Developers / James", // omitted if not available
   "queue_language_id": "en", // omitted if not available
   "session_type": "Messaging Inbound (SMS)",
   "conversation_id": "12345",
   "session_id": "78534G4RT4284", // omitted if not available
   "timestamp": "1727853575",
   "data_parameters": {
     "param1": "one",
     "param2": "two"
   }
 }
}

Assistente virtuale per le attività rimanente

Questo evento viene trasmesso quando l'assistente virtuale per le attività esce dalla sessione.

Campi di dati

  • call_id. L'identificatore di una sessione vocale (IVR).

  • chat_id. L'identificatore di una sessione di chat web o mobile.

  • campaign_id: l'identificatore di una chiamata della campagna.

  • campaign_name: il nome della campagna.

  • virtual_agent_id: l'identificatore di un assistente virtuale per le attività.

  • virtual_agent_name: il nome dell'assistente virtuale.

  • participant_id: l'identificatore del partecipante per l'assistente virtuale per le attività.

  • queue_id: l'identificatore della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • queue_path: il percorso della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • queue_language_id: la lingua della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • session_type: il tipo di sessione, ad esempio messaggistica in entrata tramite chat web.

  • conversation_id: l'identificatore delle sessioni dell'agente virtuale che utilizzano profili di conversazione.

  • session_id: l'identificatore per le sessioni dell'agente virtuale che non utilizzano profili conversazione.

  • timestamp: la data e l'ora di un evento.

  • finish_reason: il motivo della fine della sessione dell'agente virtuale.

  • data_parameters: le variabili configurate nel portale CCAI Platform e inviate all'assistente virtuale per le attività.

  • captured_variables: le variabili di sessione acquisite dall'assistente virtuale per le attività.

Payload di esempio

{
 "type": "Task_VA_Left",
 "data": {
   "chat_id": 103646,
   "campaign_id": 1432, // omitted if not available
   "campaign_name": "Survey Movie", // omitted if not available
   "virtual_agent_id": 1,
   "virtual_agent_name": "name",
   "participant_id": 1,
   "queue_id": 8469, // omitted if not available
   "queue_path": "Developers / James", // omitted if not available
   "queue_language_id": "en", // omitted if not available
   "session_type": "Messaging Inbound (SMS)",
   "conversation_id": "12345",
   "session_id": "78534G4RT4284", // omitted if not available
   "timestamp": "1727853575",
   "finish_reason": "Task VA failed", // Finish reason passed when the VTA session ends 
   "data_parameters": {
     "param1": "one",
     "param2": "two"
   },
   "captured_variables": [
     {
       "intent_name": null,
       "variables": {
           "testkey": "testvalue"
       },
       "captured_at": "2024-11-15 16:46:31 UTC",
       "timestamp": "1727853575"
     },
     {
       "intent_name": null,
       "variables": {
           "testkey2": "testvalue2"
       },
       "captured_at": "2024-11-15 16:46:31 UTC",
       "timestamp": "1727853575"
     }
   ]
 }
}

Variabili di sessione dell'assistente virtuale per le attività ricevute

Questo valore viene passato quando l'assistente virtuale per le attività invia un payload di variabile di sessione personalizzata.

Campi di dati

  • call_id. L'identificatore di una sessione vocale (IVR).

  • chat_id. L'identificatore di una sessione di chat web o mobile.

  • campaign_id: l'identificatore di una chiamata della campagna.

  • campaign_name: il nome della campagna.

  • virtual_agent_id: l'identificatore di un assistente virtuale per le attività.

  • virtual_agent_name: il nome dell'assistente virtuale.

  • queue_id: l'identificatore della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • queue_path: il percorso della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • queue_language_id: la lingua della coda da cui ha avuto origine la sessione. Questo identificatore viene incluso solo quando la sessione ha origine da una coda.

  • session_type: il tipo di sessione, ad esempio messaggistica in entrata tramite chat web.

  • conversation_id: l'identificatore delle sessioni dell'agente virtuale che utilizzano profili di conversazione.

  • session_id: l'identificatore per le sessioni dell'agente virtuale che non utilizzano profili conversazione.

  • timestamp: la data e l'ora di un evento.

  • data_parameters: le variabili configurate nel portale CCAI Platform e inviate all'assistente virtuale per le attività.

  • captured_variables: le variabili di sessione acquisite dall'assistente virtuale per le attività.

Payload di esempio

{
 "type": "Task_VA_Variables_Received",
 "data": {
   "chat_id": 103646,
   "campaign_id": 1432, // omitted if not available
   "campaign_name": "Survey Movie", // omitted if not available
   "virtual_agent_id": 1,
   "virtual_agent_name": "name",
   "participant_id": 1,
   "queue_id": 8469, // omitted if not available
   "queue_path": "Developers / James", // omitted if not available
   "queue_language_id": "en", // omitted if not available
   "session_type": "Messaging Inbound (SMS)",
   "conversation_id": "12345",
   "session_id": "78534G4RT4284", // omitted if not available
   "timestamp": "1727853575",
   "data_parameters": {
     "param1": "one",
     "param2": "two"
   },
   "captured_variables": [
     {
       "intent_name": null,
       "variables": {
           "testkey_1": "testvalue"
       },
       "captured_at": "2024-11-15 16:46:31 UTC",
       "timestamp": "1727853575"
     },
     {
       "intent_name": null,
       "variables": {
           "testkey_2": "testvalue2"
       },
       "captured_at": "2024-11-15 16:46:31 UTC",
       "timestamp" : "1727853575"
     }
   ]
 }
}

Payload di Dialogflow per le variabili di sessione personalizzate

Il payload della variabile di sessione personalizzata di Dialogflow supporta gli eventi post-attività dell'assistente virtuale.

Le proprietà disponibili nel payload della variabile di sessione del cliente includono:

  • capture_type:event: indica che i valori restituiti nel payload della variabile di sessione del cliente devono essere passati negli eventi post dell'assistente virtuale.

  • capture_type:agent: indica che i valori restituiti nel payload della variabile di sessione del cliente devono essere passati all'adattatore dell'agente.

  • capture_type:comment: indica che i valori restituiti nel payload della variabile di sessione del cliente devono essere passati nel record CRM come commento.

  • invisible_to_adapter_events. I valori delle chiavi specificate in questa proprietà devono essere esclusi dagli eventi di post dell'assistente virtuale.

Payload di esempio

{
 "ujet": {
   "session_variable": {
     "payload": {
       "key_two": "$session.params.favfood",
       "key_three": "$session.params.budget",
       "key_one": "$session.params.location",
       "key_four": "$session.params.startdate",
       "key_five": "$session.params.enddate"
     },
     "capture_type": [
       "comment",
       "agent",
       "event"
     ],
     "capture_target": "payload",
     "invisible_to_agent": [
       "key_one",
       "key_two"
     ],
     "invisible_to_adapter_events": [
       "key_three",
       "key_two"
     ]
    }
  }
}