Postar eventos para assistentes de tarefas virtuais

O adaptador do agente pode usar a API postMessage() do navegador para enviar eventos ao iFrame principal. Esses eventos podem ser consumidos por JavaScript no seu iFrame principal e usados para realizar várias ações na sua implementação personalizada de CRM. Para isso, seu aplicativo precisa detectar o MessageEvent na janela principal. Com base nos eventos, seu aplicativo pode acionar ações como abrir uma guia de tíquete para um ID de sessão específico. Os adaptadores de chamada e de chat têm eventos específicos que podem ser usados para melhorar os recursos do CRM.

A Contact Center AI Platform é compatível com os seguintes eventos do assistente de tarefas virtuais:

  • O assistente de tarefas virtual entrou

  • Assistente de tarefas virtual à esquerda

  • Variáveis de sessão personalizadas do assistente de tarefas virtuais recebidas

Para uma lista completa de eventos de postagem relacionados a adaptadores de agente, consulte Adaptadores de agente.

O assistente de tarefas virtual entrou

Esse evento é transmitido quando o assistente de tarefas virtual entra em uma sessão.

Campos de dados

  • call_id. O identificador de uma sessão de voz (URA).

  • chat_id. O identificador de uma sessão de chat na Web ou em dispositivos móveis.

  • campaign_id: o identificador de uma chamada de campanha.

  • campaign_name: o nome da campanha.

  • virtual_agent_id: o identificador de um assistente de tarefas virtual.

  • virtual_agent_name: o nome do assistente virtual de tarefas.

  • participant_id: o identificador do participante para o assistente de tarefas virtual.

  • queue_id: o identificador da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • queue_path: o caminho da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • queue_language_id: o idioma da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • session_type: o tipo de sessão, por exemplo, mensagens recebidas por chat na Web.

  • conversation_id: o identificador das sessões de agente virtual que usam perfis de conversa.

  • session_id: o identificador de sessões de agente virtual que não usam perfis de conversa.

  • timestamp: a data e a hora de um evento.

  • data_parameters: as variáveis configuradas no portal da CCAI Platform e enviadas ao assistente de tarefas virtual.

Exemplo de payload

{
 "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 de tarefas virtual à esquerda

Esse evento é transmitido quando o assistente de tarefas virtual sai da sessão.

Campos de dados

  • call_id. O identificador de uma sessão de voz (URA).

  • chat_id. O identificador de uma sessão de chat na Web ou em dispositivos móveis.

  • campaign_id: o identificador de uma chamada de campanha.

  • campaign_name: o nome da campanha.

  • virtual_agent_id: o identificador de um assistente de tarefas virtual.

  • virtual_agent_name: o nome do assistente virtual de tarefas.

  • participant_id: o identificador do participante para o assistente de tarefas virtual.

  • queue_id: o identificador da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • queue_path: o caminho da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • queue_language_id: o idioma da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • session_type: o tipo de sessão, por exemplo, mensagens recebidas por chat na Web.

  • conversation_id: o identificador das sessões de agente virtual que usam perfis de conversa.

  • session_id: o identificador de sessões de agente virtual que não usam perfis de conversa.

  • timestamp: a data e a hora de um evento.

  • finish_reason: o motivo da finalização quando a sessão do agente virtual termina.

  • data_parameters: as variáveis configuradas no portal da CCAI Platform e enviadas ao assistente de tarefas virtual.

  • captured_variables: as variáveis de sessão capturadas pelo assistente de tarefas virtual.

Exemplo de payload

{
 "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"
     }
   ]
 }
}

Variáveis de sessão do assistente de tarefas virtuais recebidas

Isso será transmitido quando o assistente de tarefas virtuais enviar uma carga útil de variável de sessão personalizada.

Campos de dados

  • call_id. O identificador de uma sessão de voz (URA).

  • chat_id. O identificador de uma sessão de chat na Web ou em dispositivos móveis.

  • campaign_id: o identificador de uma chamada de campanha.

  • campaign_name: o nome da campanha.

  • virtual_agent_id: o identificador de um assistente de tarefas virtual.

  • virtual_agent_name: o nome do assistente virtual de tarefas.

  • queue_id: o identificador da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • queue_path: o caminho da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • queue_language_id: o idioma da fila de origem da sessão. Esse identificador só é incluído quando a sessão tem origem em uma fila.

  • session_type: o tipo de sessão, por exemplo, mensagens recebidas por chat na Web.

  • conversation_id: o identificador das sessões de agente virtual que usam perfis de conversa.

  • session_id: o identificador de sessões de agente virtual que não usam perfis de conversa.

  • timestamp: a data e a hora de um evento.

  • data_parameters: as variáveis configuradas no portal da CCAI Platform e enviadas ao assistente de tarefas virtual.

  • captured_variables: as variáveis de sessão capturadas pelo assistente de tarefas virtual.

Exemplo de payload

{
 "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 do Dialogflow para variáveis de sessão personalizadas

A carga útil da variável de sessão personalizada do Dialogflow é compatível com eventos de postagem do assistente de tarefas virtuais.

As propriedades disponíveis na carga útil da variável de sessão do cliente incluem:

  • capture_type:event: indica que os valores retornados no payload da variável de sessão do cliente precisam ser transmitidos nos eventos de postagem do assistente de tarefas virtual.

  • capture_type:agent: indica que os valores retornados no payload da variável de sessão do cliente precisam ser transmitidos para o adaptador do agente.

  • capture_type:comment: indica que os valores retornados no payload da variável de sessão do cliente precisam ser transmitidos ao registro do CRM como um comentário.

  • invisible_to_adapter_events. Os valores das chaves especificadas nessa propriedade precisam ser excluídos dos eventos de postagem do assistente de tarefas virtual.

Exemplo de payload

{
 "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"
     ]
    }
  }
}