Dados de eventos da sessão de chamada da QM

Nesta página, descrevemos os dados de eventos da sessão de chamada que a Contact Center AI Platform (CCAI Platform) pode exportar para seu aplicativo de gestão de qualidade (QM). Para mais informações sobre como integrar a plataforma de CCAI ao seu aplicativo de QM, consulte Integração de QM, SIPREC e WFM.

Para dados de eventos de sessão de chat, consulte Dados de eventos de sessão de chat da QM.

Chamar eventos e gatilhos de sessão

Alguns eventos de sessão de chamada acionam a exportação de dados para seu aplicativo de QM. Esta seção lista os tipos de eventos de chamada e as ações que acionam cada um deles. Ele também inclui um exemplo de payload de evento de sessão para cada tipo de evento de sessão.

O agente faz login

Esse evento é acionado pelas seguintes ações:

  • Um agente faz login no adaptador de agente usando o portal da Contact Center AI Platform.

  • Um agente faz login no adaptador de agente usando um CRM.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "AgentState",
 "item" : {
  "ParticipantID" : "1234",
  "Email" : "some.email@domain.com",
  "State" : "login"
 }
}

O agente faz logout

Esse evento é acionado pelas seguintes ações:

  • Um agente faz logout do adaptador usando o portal do Contact Center AI Platform.

  • Um agente faz logout do adaptador de agente usando um CRM.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "AgentState",
 "item" : {
  "ParticipantID" : "1234",
  "Email" : "some.email@domain.com",
  "State" : "logout"
 }
}

A chamada recebida é projetada

Esse evento é acionado quando um usuário final faz uma ligação para a central de atendimento e a chamada é encaminhada para um atendente.

Esse evento só se aplica quando a chamada é projetada para deltacast. As projeções de multicast não acionam eventos. Somente a primeira projeção deltacast para a chamada em um grupo em cascata aciona um evento.

Esse evento inclui projeções de chamadas recebidas por transferências, redirecionamentos e desvios.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "ringing",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "ringing"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada recebida é atendida

Esse evento é acionado quando um agente atende uma chamada projetada.

Esse evento se aplica quando a chamada é atendida por um agente para projeções deltacast ou multicast. Esse evento se aplica a chamadas recebidas e atendidas por redirecionamentos e desvios de chamadas.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada de saída está tocando

Esse evento é acionado pelas seguintes ações:

  • Um agente faz uma nova chamada externa, e ela está tocando para um usuário final.

  • Um agente disca uma chamada para adicionar um participante, e ela está tocando para um terceiro.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "e9dd62bb",
  "State" : "dialing",
  "Direction" : "outgoing",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   },
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada de saída é atendida

Esse evento é acionado pelas seguintes ações:

  • Um usuário final atende uma chamada externa.

  • Um terceiro atende a uma chamada de terceiros.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "e9dd62bb",
  "State" : "connected",
  "Direction" : "outgoing",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   },
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada é colocada em espera

Esse evento é acionado pelas seguintes ações:

  • Um agente coloca um usuário final em espera.

  • Um agente coloca um terceiro em espera.

O exemplo de código a seguir mostra o payload do evento:

 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "held",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "held"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada é removida da espera

Esse evento é acionado pelas seguintes ações:

  • Um agente remove um usuário final da espera.

  • Um agente remove um terceiro da espera.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A transferência a frio é iniciada e aceita

Esse evento é acionado pelas seguintes ações:

  • Um agente faz uma transferência fria para outro agente, e a transferência é aceita.

  • Um agente faz uma transferência a frio para outra fila, e a transferência é aceita por um agente dessa fila.

  • Um agente convida outro para uma teleconferência, e o outro aceita e participa.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "transferred",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A transferência a quente é iniciada e aceita

Esse evento é acionado pelas seguintes ações:

  • Um agente faz uma transferência direta para outro agente, e a transferência é aceita.

  • Um agente faz uma transferência a quente para outra fila, e a transferência é aceita por um agente dessa fila.

  • Um agente convida outro para uma teleconferência, e o outro aceita e participa.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "conferenced",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

O agente sai de uma teleconferência

Esse evento é acionado quando um agente em uma teleconferência sai dela sem encerrar.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "participantDisconnect",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "disconnected"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada está sem áudio

Esse evento é acionado pelas seguintes ações:

  • Um agente silencia uma chamada.

  • Um agente desativa o som de outros participantes em uma chamada.

Esse evento se aplica a todas as chamadas.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,\
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "muted"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "muted"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

O som da chamada é ativado

Esse evento é acionado pelas seguintes ações:

  • Um agente ativa o som de uma ligação.

  • Um agente ativa o som de outros participantes em uma chamada.

Esse evento se aplica a todas as chamadas.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "unmuted"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "unmuted"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada é redigida

Esse evento é acionado quando um agente encobre uma chamada.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "redacted"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "redacted"
  }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada não foi editada

Esse evento é acionado quando um agente remove a redação de uma chamada.

O exemplo de código a seguir mostra o payload do evento:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "unredacted"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "unredacted"
  }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

A chamada foi encerrada

Esse evento é acionado pelas seguintes ações:

  • Um usuário final encerra uma chamada.

  • Um agente encerra uma chamada.

Esse evento se aplica a todas as chamadas.

O exemplo de código a seguir mostra o payload do evento de chamada recebida:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "disconnected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "disconnected"
   },
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "disconnected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

O exemplo de código a seguir mostra o payload do evento de chamada externa:

{
 "type" : "CallState",
 "item" : {
  "CallID" : "e9dd62bb",
  "State" : "disconnected",
  "Direction" : "outgoing",
  "Initiator" : "1234",
  "Participants" :
  [
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "disconnected"
   },
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "disconnected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

Campos de evento de sessão de chamada

As tabelas a seguir descrevem os campos nos dados da sessão que a Contact Center AI Platform exporta para seu aplicativo de QM.

Campos gerais

Nome do campo Valores permitidos Descrição Efeito
type
  • AgentState
  • CallState

O tipo de evento do payload JSON geral.

  • Transmite AgentState para eventos relacionados ao agente.
  • Transmite CallState para eventos relacionados a chamadas.

item

O objeto com informações do evento.

Campos de estado do agente

Nome do campo Valores Descrição Comportamento

ParticipantID

Um ID de agente

Disponível no objeto item.

O identificador do agente no sistema da Contact Center AI Platform.

  • Transmite o valor do campo "ID" no objeto agent_info nos metadados da sessão da Contact Center AI Platform.

Email

Um endereço de e-mail

Disponível no objeto item.

O endereço de e-mail do agente.

  • Transmite o valor do campo de e-mail no objeto agent_info nos metadados da sessão.

State

  • login
  • logout

Disponível no objeto item.

O estado do agente no momento do evento.

  • Transmite login quando o agente está conectado.
  • Transmite logout quando o agente não está conectado.

Campos de estado da chamada

Nome do campo Valores Descrição Comportamento

CallID

O ID da chamada

Disponível no objeto item.

O identificador da sessão de chamada no sistema da Contact Center AI Platform.

  • Transmite o valor do campo "ID" no objeto principal nos metadados da sessão da Contact Center AI Platform.

State

  • dialing
  • waiting
  • ringing
  • connected
  • redirected
  • deflected
  • transferred
  • conferenced
  • disconnected

Disponível no objeto item.

O estado atual da sessão de chamada.

  • Transmite dialing quando uma chamada externa está em estado de toque para o agente ou usuário final.
  • Transmite waiting quando a chamada é colocada na fila para projeção aos agentes.
  • Transmite ringing quando uma chamada recebida/transferida está no estado de projeção para o agente.
  • Transmite connected quando o agente ou o usuário final está conectado à conferência telefônica.
  • Transmite redirected quando a chamada é redirecionada automaticamente sem ser encaminhada para os agentes.
  • Envia transferred quando a chamada é transferida a frio de um agente para outro.
  • Transmite conferenced quando a chamada é transferida de um agente para outro.
  • Transmite disconnected quando o agente ou o usuário final sai da conferência telefônica.

Direction

  • incoming
  • outgoing

Disponível no objeto item.

A direção da sessão de chamada da perspectiva da central de contatos.

  • Transmite incoming quando a sessão de chamada é de entrada.
  • Transmite outgoing quando a sessão de chamada é de saída.

Initiator

  • O ID do agente
  • O ID do agente virtual
  • O número de telefone do usuário final

Disponível no objeto item.

O identificador da parte que inicializa o estado da chamada.

  • Para agentes humanos

    Transmite o valor do campo "ID" no objeto agent_info nos metadados da sessão.

  • Para agentes virtuais

    Transmite o valor do campo virtual_agent_id no objeto de participantes nos metadados da sessão.

  • Para usuários finais

    Transmite o número de telefone do usuário final, se disponível.

    Caso contrário, transmite o valor do campo "ID" no objeto end_user nos metadados da sessão.

Queue_path_ids

Um caminho de IDs de fila

Disponível no objeto item.

O caminho da fila navegado pelo usuário final antes de chegar ao primeiro agente da ligação.

Esse valor é criado usando os IDs da fila navegada.

Isso se aplica apenas a chamadas recebidas.

Queue_path_names

Um caminho de nomes de filas

Disponível no objeto item.

O caminho da fila navegado pelo usuário final antes de chegar ao primeiro agente da ligação.

Esse valor é criado usando os nomes da fila navegada.

Isso se aplica apenas a chamadas recebidas.

Language

O código do idioma

Disponível no objeto item.

O código do idioma selecionado pelo usuário final.

Isso se aplica apenas a chamadas recebidas.

Queue_uuid

O ID da fila

Disponível no objeto item.

O UUID da fila em que a chamada chega.

Isso se aplica apenas a chamadas recebidas e transferidas da fila.

Recording_permitted

Um booleano

Disponível no objeto item.

Indica se a gravação de chamadas é permitida para a chamada específica.

  • Transmite true se a gravação de chamadas for permitida.
  • Transmite false se a gravação de chamadas não for permitida.

Custom_headers

cabeçalhos personalizados

Disponível no objeto item.

Esse campo é usado para transmitir dados personalizados, como cabeçalhos SIP.

Participants

Esse objeto está aninhado no objeto item.

Um objeto que contém as informações do participante da chamada.

ParticipantID

  • agent_id
  • virtual_agent_id
  • consumer_phoneNumber
  • thirdParty_phoneNumber

Disponível no objeto Participants.

O identificador do participante da chamada.

  • Para agentes humanos
  • Transmite o valor do campo "ID" no objeto agent_info nos metadados da sessão da Contact Center AI Platform.

  • Para agentes virtuais
  • Transmite o valor do campo virtual_agent_id no objeto de participantes nos metadados da sessão da Contact Center AI Platform.

  • Para usuários finais
  • Transmite o número de telefone do usuário final, se disponível.

    Caso contrário, transmite o valor do campo id no end_user object nos metadados da sessão da Contact Center AI Platform.

  • Para terceiros
  • Transmite o número de telefone do terceiro, se disponível.

    Caso contrário, transmite o valor: null.

Type

  • agent
  • external

Disponível no objeto Participants.

O tipo de participante da chamada.

  • Transmite agent quando o participante da chamada é um agente da Contact Center AI Platform.
  • Transmite external quando o participante da chamada é um usuário final ou um terceiro.

State

  • dialing
  • ringing
  • connected
  • held
  • disconnected
  • callback
  • deflected
  • transferred
  • redacted
  • unredacted
  • muted
  • unmuted

Disponível no objeto Participants.

O estado atual do participante na conferência.

  • Transmite dialing quando um segmento de chamada externa está em estado de toque para o agente, o usuário final ou terceiros.
  • Transmite ringing quando um segmento de chamada recebida ou transferida está no estado de projeção para o agente.
  • Transmite connected quando o agente, o usuário final ou um terceiro está conectado à conferência telefônica.
  • Transmite held quando o usuário final ou terceirizado é colocado em espera na conferência telefônica pelo agente.
  • Transmite disconnected quando o agente, o usuário final ou um terceiro sai da conferência.
  • Transmite redacted quando a redação de chamadas está ativada no agente, no usuário final ou no segmento de chamadas de terceiros.
  • Transmite unredacted quando a remoção de informações sensíveis da chamada está desativada no agente, no usuário final ou no segmento de chamada de terceiros.
  • Transmite muted quando o agente é silenciado.
  • Transmite unmuted quando o agente é removido do modo silencioso

MediaID

  • twilio_mediaID
  • nexmo_mediaID

Disponível no objeto Participants.

O identificador da mídia da sessão de chamada da operadora.

  • Transmite o twilio_mediaID quando o iniciador liga para ou de um número do Twilio.
  • Transmite o nexmo_mediaID quando o iniciador faz ou recebe uma ligação de um número da Nexmo.