Metadados da sessão de chamada

Este documento fornece o esquema do registro de metadados da sessão de chamada, o documento JSON emitido pela UJET no final de cada ligação. O UJET entrega o registro à sua integração de CRM como o corpo do comando de fim de sessão e grava o registro na sua configuração de armazenamento externo como um arquivo metadata.json. Cada chamada produz exatamente um registro. O id de nível superior identifica cada registro de maneira exclusiva. Use esse esquema para ingerir registros em sistemas downstream, validar payloads recebidos ou mapear campos em colunas do data warehouse.

Raiz do esquema

O registro de metadados da sessão de chamada é um único objeto JSON que representa uma sessão de chamada de voz. Três conceitos no nível superior determinam a identidade e o formato do registro.

Chave primária: id (número inteiro)

O id de nível superior identifica exclusivamente a sessão de chamada no seu locatário. Um registro existe por chamada. Todos os outros campos de nível superior, matrizes e objetos aninhados descrevem atributos da chamada que este id identifica.

Discriminador de gerenciador: agent_info (objeto, oneOf)

Um único objeto cuja forma varia dependendo do último manipulador da chamada. As duas variantes são mutuamente exclusivas. O registro contém apenas uma variante:

• Variante humano-agente: presente se um agente humano atendeu a chamada por último. Contém email, first_name, last_name e agent_number, além dos campos compartilhados id, name e avatar_url.

• Variante de agente virtual: presente se um agente virtual atendeu a chamada por último. Transmite va_alias e omite email, first_name, last_name e agent_number.

Para detectar qual variante um registro carrega, verifique a presença de um campo específico da variante, geralmente agent_info.email para a variante de agente humano ou agent_info.va_alias para a variante de agente virtual. Para ver o formato completo de cada variante, consulte agent e virtual_agent.

Discriminadores de formato de chamada: call_type, session_type, session_type_v2 (string)

Três visualizações paralelas do mesmo tipo de chamada subjacente. Eles nunca discordam sobre qual tipo de chamada um registro representa. A diferença está apenas no vocabulário usado para nomear o tipo de chamada.

• call_type usa o vocabulário de enumeração legado (por exemplo, Voice Inbound (App), Voice Outbound ou Voice Internal).

• session_type sempre retorna a mesma string que call_type. A UJET fornece esse campo para compatibilidade com versões anteriores de integrações que usam esse campo. Trate-o como um alias descontinuado de call_type. Consulte Controle de versões e descontinuações.

• session_type_v2 usa o vocabulário de enumeração atual. Esse vocabulário estende o vocabulário call_type com distinções de entrada mais refinadas, por exemplo, Voice Inbound (Mobile) e Voice Inbound (IVR using Mobile) em vez de Voice Inbound (App) e Voice Inbound (IVR using App). Para tipos de chamada que não têm um valor específico da v2, session_type_v2 retorna a mesma string que call_type. As novas integrações precisam analisar session_type_v2.

Para os valores de cada campo, consulte Informações principais.

Informações principais

Essas propriedades capturam as informações principais da chamada:

• id (número inteiro): um identificador exclusivo para cada sessão de chamada. Essa é a chave primária que distingue uma chamada de outra.

• call_uuid (string ou nulo): um identificador exclusivo que correlaciona uma chamada em locatários de origem e de recebimento nas interações de roteamento dinâmico de chamadas (DCR). As duas partes de uma chamada de DCR compartilham o mesmo valor de call_uuid, permitindo que os clientes façam a ponte entre dados de ambientes diferentes. O campo é nulo ou vazio para qualquer chamada que não seja uma interação de DCR e para chamadas que ocorreram antes de a UJET adicionar o campo.

• lang (string): o código de idioma ISO 639 da chamada (por exemplo, "en" para inglês ou "es" para espanhol). Esse código ajuda a realizar análises e gerar relatórios específicos de idiomas.

• call_type (string): o tipo de chamada, usando o vocabulário de tipo legado. Os valores incluem "Entrada de voz (app)", "Entrada de voz (Web)", "Entrada de voz (URA)", "Entrada de voz (URA usando app)", "Entrada de voz (API)", "Entrada de voz (direta)", "Entrada de voz (extensão)", "Voz agendada (app)", "Voz agendada (Web)", "Voz agendada (API)", "Retorno de chamada por voz", "Retorno de chamada por voz (Web)", "Saída de voz", "Saída de voz (API)", "Saída de voz (direta)", "Saída de voz (UCaaS)", "Voz interna", "Campanha de voz (Acqueon)", "Campanha de voz (<nome da sua marca>)" e "Chamada agendada do agente".

• session_type (string): um duplicado de call_type (mesmos valores) que a UJET mantém para compatibilidade com versões anteriores. Consulte Controle de versões e descontinuações: duplicatas legadas.

• session_type_v2 (string): o tipo de chamada, usando o vocabulário atual. Ele refina os valores de call_type com distinções de entrada mais detalhadas (por exemplo, "Entrada de voz (dispositivo móvel)" e "Entrada de voz (URA usando dispositivo móvel)" em vez de "Entrada de voz (app)" e "Entrada de voz (URA usando app)"). Os valores incluem "Entrada de voz (dispositivo móvel)", "Entrada de voz (Web)", "Entrada de voz (URA)", "Entrada de voz (URA usando dispositivo móvel)", "Entrada de voz (API)", "Entrada de voz (direta)", "Entrada de voz (extensão)", "Voz programada (dispositivo móvel)", "Voz programada (Web)", "Voz programada (API)", "Retorno de chamada de voz", "Retorno de chamada de voz (Web)", "Saída de voz", "Saída de voz (API)", "Saída de voz (direta)", "Saída de voz (UCaaS)", "Voz interna", "Campanha de voz (Acqueon)", "Campanha de voz (<nome da sua marca>)" e "Chamada programada do agente".

• status (string): o status atual da chamada. Os valores possíveis incluem "scheduled", "queued", "connected", "finished", "failed" e "deflected". Isso acompanha a progressão da chamada ao longo do ciclo de vida.

• created_at (string, data/hora): o carimbo de data/hora exato em que a UJET criou o registro de chamada.

• queued_at (string, data/hora ou nulo): o carimbo de data/hora em que a chamada entrou na fila ou nulo se a chamada não entrou na fila.

• assigned_at (string, data/hora ou nulo): o carimbo de data/hora em que o UJET atribuiu a chamada a um agente ou nulo se o UJET não atribuiu a chamada.

• connected_at (string, data/hora ou nulo): o carimbo de data/hora em que a chamada foi conectada.

• ends_at (string, data/hora ou nulo): o carimbo de data/hora em que a chamada terminou.

• scheduled_at (string, data/hora ou nulo): o carimbo de data/hora em que o UJET agendou a ligação ou nulo se a ligação foi imediata.

• updated_at (string, data/hora): o carimbo de data/hora da última atualização dos dados de chamada pela UJET.

• wait_duration (número inteiro ou nulo): o tempo total que o consumidor passou na fila durante toda a chamada, em segundos, ou nulo se o UJET não registrou nenhum tempo de espera. Para ver o tempo na fila dividido por segmento individual, consulte a matriz queue_durations (Durações na fila). Consulte Controle de versões e descontinuações: nomenclatura do campo "Tempo de espera".

• call_duration (número inteiro ou nulo): a duração total da chamada, em segundos.

• hold_duration (número inteiro ou nulo): o tempo total que o consumidor passou em espera, em segundos, ou nulo se não houve tempo de espera.

• rating (número inteiro ou nulo): a classificação de satisfação do cliente (CSAT) enviada pelo consumidor ou nulo se ele não enviou uma classificação.

• has_feedback (booleano): uma flag que indica se o consumidor enviou feedback após a chamada.

• voip_provider (string): o provedor de VoIP da chamada. Observação: esse campo foi descontinuado e sempre retorna "deprecated".

• out_ticket_id (string ou nulo): o ID do tíquete criado pela UJET no sistema de CRM externo.

• out_ticket_url (string, uri ou null): o URL do tíquete do CRM.

• is_out_ticket_account (booleano ou nulo): indica se o tíquete do CRM representa um cliente (verdadeiro) ou uma interação de chamada (falso).

• verified (booleano): indica se a ação inteligente de verificação verificou a interação.

• recording_url (string, URI ou nulo): o URL da gravação de chamada ou nulo se nenhuma gravação estiver disponível.

• recording_permission (string ou nulo): o status da permissão de gravação do consumidor. Valores possíveis: "not_asked", "granted", "denied".

• voicemail_reason (string): o motivo de um correio de voz, se aplicável. As opções incluem "not_voicemail", "temporary_redirection" e "after_hour_deflection".

• disconnected_by (string ou nulo): indica quem encerrou a chamada. Valores possíveis: disconnected_by_unknown, disconnected_by_agent, disconnected_by_end_user, disconnected_by_virtual_agent, disconnected_by_system.

• fail_reason (string ou nulo): o motivo da falha de uma chamada ou "nada" para chamadas que não falharam. Os valores possíveis incluem nothing, unknown, expired, eu_canceled, eu_rejected, eu_abandoned, eu_in_menu_abandoned, eu_busy, eu_wrong_number, eu_no_answer, eu_noti_failed, ag_canceled, ag_ignored, ag_mic_no_device, ag_mic_denied, voip_twilio_error, voip_tokbox_error, voip_invalid_token, voip_conn_general, voip_conn_timeout, voip_conn_signal.

• fail_details (string ou nulo): detalhe adicional legível por humanos que acompanha fail_reason, quando disponível.

• adapter_fail_code (inteiro ou nulo): código numérico correspondente a fail_reason no nível da chamada. Nulo quando a chamada não falha. A mesma enumeração é usada em adapter_fail_code por participante no §17.

• adapter_fail_message (string ou nulo): mensagem legível correspondente a adapter_fail_code. Nulo quando a chamada não falha.

• support_number (string ou nulo): o número de telefone que o consumidor discou para entrar em contato com a central de atendimento, no formato E.164. Preenchido para chamadas originadas por URA. Pode ser nulo para outros canais.

• queue_priority_level (número inteiro; presente apenas quando a prioridade da fila está ativada na sua conta): a prioridade da fila atribuída à chamada.

Informações do agente e do agente virtual

Estas seções explicam quem ou o que atendeu a ligação:

• agent_info (objeto): esse campo pode conter informações sobre um agente humano ou virtual. Ele usa a palavra-chave oneOf para especificar que pode ser de um de dois tipos.

  • agent (objeto): informações sobre o agente humano:

    • id (número inteiro): o ID exclusivo do agente.

    • agent_number (string ou nulo): um identificador atribuído ao agente.

    • email (string, e-mail): o endereço de e-mail do agente.

    • name (string): o nome completo do agente.

    • last_name (string): o sobrenome do agente.

    • first_name (string): o primeiro nome do agente.

    • avatar_url (string, uri): o URL da imagem do avatar do agente.

  • virtual_agent (objeto): informações sobre o agente virtual:

    • id (número inteiro): o ID exclusivo do agente virtual.

    • name (string): o nome do agente virtual.

    • avatar_url (string, uri ou nulo): o URL da imagem do avatar do agente virtual.

    • va_alias (string ou nulo): o alias de exibição do agente virtual, se você tiver definido um. Sempre presente no payload. Nulo quando nenhum alias é definido.

Navegação pelos menus

• selected_menu (objeto ou nulo): informações sobre o menu que o consumidor selecionou durante a chamada.

  • id (número inteiro): o ID exclusivo do menu.

  • name (string): o nome do menu.

  • parent_id (inteiro ou nulo): o ID do menu pai, se houver.

  • position (número inteiro): a posição do menu em relação a outros menus no mesmo nível.

  • deleted (booleano): indica se o menu foi excluído.

  • menu_type (string): o tipo de menu, como ivr_menu ou sms_menu.

  • hidden (booleano): se o menu está visível e disponível para uso.

• menu_path (objeto ou nulo): descreve o caminho hierárquico dos menus que o consumidor navegou.

  • items_count (número inteiro): o número de menus no caminho.

  • name (string): uma string separada por barras com nomes de menus (por exemplo, "Support/Billing").

  • materialized_path (string): uma string de IDs de menu separados por barras.

• automation_redirection (objeto; presente apenas quando o primeiro registro de rejeição da chamada está associado a um grupo de redirecionamento): detalhes sobre o redirecionamento de fila com base em porcentagem que afetou o encaminhamento dessa chamada.

  • percent_redirection (booleano): se você ativou o redirecionamento com base em porcentagem no menu de origem.

  • redirection_group (matriz): matriz de um elemento que contém os detalhes do grupo de redirecionamento:

    • group_label (string): rótulo legível para o grupo de redirecionamento (por exemplo, "Grupo de redirecionamento 1").

    • destination (objeto ou nulo): o destino de redirecionamento que você configurou no grupo.

    • after_hours (booleano ou nulo): indica se você ativou as opções de desvio fora do horário comercial no grupo.

    • ah_destination (objeto ou nulo): o destino de redirecionamento fora do horário de expediente que você configurou no grupo.

Detalhes do usuário final

• end_user (objeto ou nulo): informações sobre o consumidor:

  • id (inteiro ou nulo): o ID interno do consumidor.

  • identifier (string ou nulo): um identificador externo do consumidor.

  • out_contact_id (string ou nulo): o ID do consumidor no CRM.

Dados personalizados e fornecidos pelo SDK

• customer_flag (objeto; presente apenas quando o site transmitiu dados de autenticação personalizados): atributos de dados personalizados relacionados à autenticação que o app ou site do consumidor transmitiu no início da sessão. O payload inclui apenas o subconjunto que você designa como parâmetros de autenticação.

• api_dap_request (objeto; presente apenas quando você ativa e configura os parâmetros de dados para inclusão nos metadados da sessão): um snapshot dos valores de parâmetro de dados da chamada, conforme você os configura nas configurações de API externa da sua conta. As chaves e os tipos de valores dependem da configuração do parâmetro de dados.

• form_responses (matriz; presente apenas quando o consumidor enviou pelo menos uma resposta do formulário): respostas coletadas pelos formulários do SDK na chamada durante a sessão. Cada entrada contém:

  • id (string ou número inteiro): identificador da resposta do formulário.

  • title (string): título do formulário mostrado ao consumidor.

  • smart_action_id (número inteiro ou nulo): identificador da ação inteligente que acionou o formulário, se houver.

  • questions (matriz): os pares de perguntas e respostas coletados.

Anexos

• photos (matriz): fotos que o consumidor enviou durante a chamada.

  • id (número inteiro): identificador exclusivo da foto.

  • photo_type (string): tipo ou origem da foto (por exemplo, "photo").

  • url (string, uri): URL da foto armazenada.

  • smart_action_type (string ou nulo): a ação inteligente que gerou a foto, se houver.

  • transfer_id (número inteiro ou nulo): o ID do evento de transferência da foto, se o consumidor fez upload dela após uma transferência.

• videos (matriz): vídeos enviados pelo consumidor durante a chamada.

  • id (número inteiro): identificador exclusivo do vídeo.

  • url (string, uri): URL do vídeo armazenado.

  • smart_action_type (string ou nulo): a ação inteligente que produziu o vídeo, se houver.

  • transfer_id (número inteiro ou nulo): o ID do evento de transferência do vídeo, se o consumidor fez o upload dele após uma transferência.

Desvio de chamadas

• deflection (string): indica se e como a chamada foi desviada (por exemplo, "no_deflection", "over_cap_phone" ou "after_hours_voicemail").

• deflection_details (matriz): fornece um registro detalhado das evasões durante a chamada. O campo de deflexão em cada entrada usa a enumeração definida em Definições: deflexão. Cada entrada inclui:

  • id (número inteiro): identificador exclusivo do registro de log de evasão.

  • call_id (número inteiro): identificador exclusivo da chamada.

  • transfer_id (inteiro ou nulo): identificador exclusivo da transferência associada à evasão, se aplicável.

  • deflection (string; consulte Definições: evasão para valores permitidos): o tipo de evasão.

  • created_at (string, data e hora): carimbo de data/hora em que a recusa ocorreu.

  • from_menu_path (objeto ou nulo): caminho do menu em que a deflexão começou.

  • to_menu_path (objeto ou nulo): caminho do menu para onde a UJET desviou a chamada.

  • to_sip_uri (string; presente apenas quando o UJET redirecionou a chamada para um destino SIP): URI SIP para o qual o UJET redirecionou a chamada, se aplicável.

  • to_sip_headers (objeto; presente apenas quando o UJET redirecionou a chamada para um destino SIP): cabeçalhos SIP com que o UJET redirecionou a chamada, se aplicável.

Transferências

• transfers (matriz): uma entrada por evento de transferência durante a chamada. Registra transferências diretas e indiretas entre agentes, agentes virtuais e menus.

  • id (número inteiro): identificador exclusivo da transferência.

  • status (string): status atual da transferência (por exemplo, transferindo, conectado ou falha).

  • fail_reason (string): motivo da falha na transferência ou "nothing" se não houve falha.

  • created_at (string, data e hora): quando a transferência começou.

  • assigned_at (string, data e hora ou nulo): quando a UJET atribuiu a transferência à parte receptora.

  • connected_at (string, data e hora ou nulo): quando a transferência conectada.

  • updated_at (string, data e hora): quando a UJET atualizou o registro de transferência pela última vez.

  • call_duration (número inteiro): duração da chamada do segmento transferido, em segundos.

  • wait_duration (número inteiro): tempo que o consumidor esperou durante a transferência, em segundos.

  • deflection (string): tipo de desvio associado à transferência, se houver.

  • answer_type_path (string ou nulo): caminho que descreve como a chamada transferida foi resolvida.

  • from_menu_path / to_menu_path (objeto ou nulo): caminho do menu antes e depois da transferência; mesmo formato de menu_path em Definições.

  • from_agent / to_agent (objeto ou nulo): agente humano em cada lado da transferência; mesmo formato do objeto agent em Definições.

  • from_virtual_agent / to_virtual_agent (objeto ou nulo): agente virtual em cada lado da transferência; mesmo formato do objeto virtual_agent em Definitions.

  • from_queue_priority_level / to_queue_priority_level (número inteiro ou nulo): prioridade da fila antes e depois da transferência. Presente apenas quando você ativa a prioridade da fila na sua conta.

Durações de atendimento de chamadas

• handle_durations (matriz): uma matriz de objetos, cada um representando um segmento da chamada atendida por um agente. Isso ajuda na análise do tempo de atendimento do agente.

  • id (número inteiro): identificador exclusivo da duração do atendimento.

  • agent_id (número inteiro): ID do agente.

  • acw_duration (número inteiro): duração do trabalho após a ligação.

  • bcw_duration (número inteiro): duração do trabalho antes da chamada.

  • call_duration (número inteiro): duração da chamada durante esse segmento.

  • menu_path_id (inteiro ou nulo): ID do caminho do menu.

  • menu_path (string): nome do caminho do menu.

  • lang (string): idioma usado.

  • barged (booleano): se o supervisor invadiu a chamada.

  • transfer (booleano): indica se uma transferência ocorreu.

  • transfer_id (inteiro ou nulo): ID da transferência.

  • transfer_cold (booleano ou nulo): indica se a transferência foi cega.

  • started_at (string, data/hora): carimbo de data/hora de início.

  • ended_at (string, data/hora ou nulo): carimbo de data/hora de término.

  • scheduled_at (string, data/hora ou nulo): carimbo de data/hora programado.

  • hold_duration (número inteiro ou nulo): duração da espera durante este segmento.

  • assigned_connection_duration (número inteiro): duração da espera do consumidor enquanto o agente se conectava durante essa fase.

  • session_breakthrough (objeto; presente apenas quando a chamada interrompeu o status indisponível de um agente): detalhes sobre a atribuição da chamada que interrompeu o status indisponível de um agente, se aplicável.

Durações na fila

• queue_durations (matriz): uma matriz de objetos, cada um representando um segmento da chamada em que o consumidor estava em uma fila. Isso ajuda na análise de tempos de espera e níveis de serviço.

  • id (número inteiro): identificador exclusivo da duração da fila.

  • agent_id (número inteiro): ID do agente.

  • ended_at (string, data e hora): carimbo de data/hora de término.

  • lang (string): idioma usado.

  • menu_path_id (número inteiro): ID do caminho do menu.

  • menu_path (string): nome do caminho do menu.

  • queue_duration (inteiro): duração do segmento da fila.

  • started_at (string, data/hora): carimbo de data/hora de início.

  • transfer_cold (booleano): indica se a transferência cega de chamada foi feita.

  • transfer (booleano): indica se uma transferência ocorreu.

  • transfer_id (inteiro ou nulo): ID da transferência.

  • service_level_abandon_time_threshold (número inteiro): limite de tempo para abandono do nível de serviço.

  • service_level_event (string): status do evento de nível de serviço ("excluded", "in_sla", "not_in_sla").

  • service_level_target_percent (inteiro): porcentagem desejada para conformidade com o nível de serviço.

  • service_level_target_time (número inteiro): tempo desejado para conformidade com o nível de serviço.

Encaminhamentos de agentes virtuais para humanos

• escalations (matriz): cada entrada representa um encaminhamento de um agente virtual para um agente humano.

  • id (número inteiro): identificador exclusivo da escalonamento.

  • status (string): status atual (por exemplo, em escalonamento, escalonado ou com falha).

  • reason (string): motivo da escalonamento da sessão.

  • created_at (string, data e hora): quando o encaminhamento começou.

  • escalated_at (string, data e hora ou nulo): quando a escalonamento foi concluído.

  • from_virtual_agent (objeto ou nulo): agente virtual que encaminhou a chamada. Tem o mesmo formato do objeto virtual_agent em Definições.

  • to_agent (objeto ou nulo): agente humano para quem a chamada foi encaminhada. Mesmo formato do objeto agent em Definitions.

  • from_menu_path / to_menu_path (objeto ou nulo): caminho do menu antes e depois do encaminhamento.

Encaminhamentos para um supervisor pelo agente virtual

• virtual_agent_deflected_escalations (matriz): detalhes de encaminhamentos evitados de agentes virtuais.

  • id (número inteiro): identificador exclusivo.

  • deflection (string): tipo de evasão.

  • escalation_id (número inteiro): identificador do evento de encaminhamento.

  • escalation_reason (string): motivo do encaminhamento.

  • escalated_at (string, data e hora): carimbo de data/hora da escalonamento.

  • menu_path_id (número inteiro): ID do caminho do menu.

  • menu_path (string): caminho do menu.

  • lang (string): idioma.

  • virtual_agent (objeto): detalhes do agente virtual. Consulte Definições.

Durações de atendimento do agente virtual

• virtual_agent_handle_durations (matriz): segmentos de tempo em que um agente virtual atendeu a chamada.

  • id (número inteiro): identificador exclusivo.

  • virtual_agent (objeto): detalhes do agente virtual. Consulte Definições.

  • call_duration (número inteiro): duração do segmento.

  • escalation_reason (string): motivo do encaminhamento.

  • finish_reason (string): motivo do encerramento da interação.

  • sentiment (número inteiro): sentimento do consumidor.

  • response_count (número inteiro): contagem de respostas do agente virtual.

  • fallback_response_count (número inteiro): contagem de respostas substitutas.

  • initiated_by (string): como a sessão do agente virtual foi iniciada.

  • menu_path_id (número inteiro): ID do caminho do menu.

  • menu_path (string): caminho do menu.

  • lang (string): idioma.

  • transfer (booleano): indica se a chamada foi transferida.

  • transfer_id (inteiro ou nulo): identificador do evento de transferência.

  • started_at (string, data/hora): carimbo de data/hora de início.

  • ended_at (string, data/hora ou nulo): carimbo de data/hora de término.

Durações do atendimento ao consumidor

• consumer_handle_durations (matriz): durações em que o consumidor ficou na ligação.

  • id (número inteiro): identificador exclusivo.

  • call_duration (número inteiro): duração do segmento de consumidor.

  • hold_duration (número inteiro ou nulo): duração da retenção do consumidor.

  • started_at (string, data/hora): carimbo de data/hora de início.

  • ended_at (string, data e hora): carimbo de data/hora de término.

Durações de eventos do consumidor

• consumer_event_durations (matriz): detalhes dos eventos de chamada do consumidor (como CSAT ou pagamento).

  • id (número inteiro): identificador exclusivo.

  • duration (número inteiro): duração do evento.

  • type (string): tipo de evento.

  • event (string): resultado do evento.

  • menu_path_id (número inteiro): ID do caminho do menu.

  • menu_path (string): caminho do menu.

  • lang (string): idioma.

  • started_at (string, data/hora): carimbo de data/hora de início.

  • ended_at (string, data e hora): carimbo de data/hora de término.

Durações no menu do consumidor

• consumer_in_menu_durations (matriz): durações das interações do consumidor nos menus.

  • id (número inteiro): identificador exclusivo.

  • duration (número inteiro): duração no menu.

  • event (string): resultado da interação com o menu.

  • menu_path_id (número inteiro): ID do caminho do menu.

  • menu_path (string): caminho do menu.

  • lang (string): idioma.

  • started_at (string, data/hora): carimbo de data/hora de início.

  • ended_at (string, data e hora): carimbo de data/hora de término.

Participantes

• participants (matriz): informações sobre cada participante da chamada (por exemplo, o consumidor, o atendente ou o agente virtual).

  • id (número inteiro): identificador exclusivo do participante.

  • type (string): tipo de participante ("end_user", "agent", "virtual_agent" etc.).

  • entry_type (string): como o participante entrou na chamada.

  • user_id (número inteiro ou nulo): ID do usuário se o participante for um agente.

  • end_user_id (número inteiro ou nulo): identificador do consumidor se o participante for o consumidor.

  • virtual_agent_id (número inteiro ou nulo): ID do agente virtual se o participante for um agente virtual.

  • virtual_agent_params (objeto; presente apenas quando você configura metadados personalizados do agente virtual para inclusão): metadados personalizados usados pelo agente virtual.

  • status (string): status do participante ("waiting", "connected", "finished" etc.).

  • fail_reason (string): motivo da falha, se houver.

  • connected_at (string, data/hora ou nulo): carimbo de data/hora em que o participante se conectou.

  • phone_number (string; presente apenas em participantes consumidores): número de telefone do participante.

  • call_id (número inteiro): identificador da chamada.

  • call_duration (inteiro ou nulo): duração da chamada para o participante.

  • hold_duration (inteiro ou nulo): duração da espera para o participante.

  • ended_at (string, data/hora ou nulo): carimbo de data/hora em que o envolvimento do participante terminou.

  • adapter_fail_code (número inteiro ou nulo): código numérico correspondente ao motivo da falha.

  • adapter_fail_message (string ou nulo): descrição legível de fail_reason, se presente.

  • agent_assist (objeto; presente apenas em participantes do agente quando você configura o Agent Assist): configurações ativas do Agent Assist para este participante.

  • virtual_agent (objeto; presente apenas em participantes de agentes virtuais): detalhes do agente virtual que serve como participante, diferente do agent_info de nível superior e do virtual_agent_params.

  • caller_id (string; presente apenas quando você ativa o ID de chamadas do cabeçalho SIP na sua conta e apenas em participantes consumidores): identificador de chamadas que o UJET extrai dos cabeçalhos SIP de entrada para esse participante consumidor.

  • sip_headers (objeto ou nulo): cabeçalhos SIP associados a este participante. Sempre presente no payload. Nulo quando o UJET não captura cabeçalhos.

  • location (string ou nulo; presente apenas em participantes agentes): o local do agente.

  • location_id (inteiro ou nulo; presente apenas em participantes do agente): o ID do local.

  • email (string, e-mail; presente apenas em participantes agentes): o endereço de e-mail do agente.

  • first_name (string ou nulo; presente apenas em participantes do agente): o primeiro nome do agente.

  • last_name (string ou nulo; presente apenas em participantes agentes): o sobrenome do agente.

  • middle_name (string ou nulo; presente apenas em participantes do agente): o nome do meio do agente.

  • teams (matriz; presente apenas em participantes agentes): matriz de objetos { id, name } para as equipes do agente.

Gravações

• recordings (matriz): informações sobre a gravação de áudio de chamadas.

  • id (inteiro): identificador exclusivo da gravação.

  • call_id (número inteiro): identificador da chamada.

  • conference_sid (string ou nulo): identificador de chamada do provedor de VoIP.

  • duration (número inteiro ou nulo): duração da gravação.

  • recording_type (string): tipo de gravação.

  • redaction_times (matriz): segmentos de tempo redigidos.

    • start (string, data e hora): quando o intervalo de redação começou.

    • end (string, data e hora): quando o intervalo de redação terminou.

    • duration (número inteiro): duração da redação, em segundos.

    • start_agent_id (número inteiro ou nulo): o agente que iniciou a redação.

    • end_agent_id (número inteiro ou nulo): o agente que encerrou a redação.

  • started_at (string, data e hora): carimbo de data/hora do início da gravação.

• post_processed_recordings (matriz; presente apenas quando você ativa a gravação pós-processada na sua conta): gravações de áudio que o pós-processamento produz, como conversão de formato ou redação.

  • id (número inteiro): identificador exclusivo da gravação pós-processada.

  • call_id (número inteiro): identificador da chamada.

  • duration (número inteiro): duração da gravação em segundos.

  • started_at (string, data e hora): carimbo de data/hora do início da gravação.

  • recording_file_name (string): nome do arquivo do recurso de áudio pós-processado.

  • recording_url (string, uri): URL do arquivo de áudio pós-processado.

  • agent_id (inteiro ou string): identificador do agente associado ao segmento.

  • virtual_agent_id (inteiro ou string): identificador do agente virtual associado ao segmento, se houver.

  • conversation_id (string): identificador que correlaciona esta gravação com o registro da conversa.

• segments (matriz; presente apenas quando você ativa as gravações de insights pós-processados na sua conta): segmentos de áudio por participante (e gravação de tela opcional) que o sistema produz para pipelines de insights downstream.

  • id (número inteiro): identificador exclusivo do segmento.

  • call_id (número inteiro): identificador da chamada.

  • duration (número inteiro): duração do segmento em segundos.

  • started_at (string, data e hora): carimbo de data/hora de início do segmento.

  • audio_file_name (string): nome do arquivo do recurso de áudio do segmento.

  • audio_url (string, uri): URL do arquivo de áudio do segmento.

  • agent_id (inteiro ou string): identificador do agente associado ao segmento.

  • virtual_agent_id (inteiro ou string): identificador do agente virtual associado ao segmento, se houver.

  • participant_id (inteiro ou string): identificador do participante a que o segmento pertence.

  • conversation_id (string): identificador que correlaciona esse segmento ao registro de conversa.

  • screen_recording_url (string, uri ou nulo): URL do recurso de gravação de tela correspondente. Presente apenas quando você ativa a gravação de tela na sua conta.

  • screen_recording_file_name (string ou nulo): nome do arquivo da gravação de tela. Presente na mesma condição que screen_recording_url.

Oferecer eventos

• offer_type (string ou nulo): como a UJET ofereceu a ligação ao agente.

• offer_events (matriz): eventos quando a UJET ofereceu a ligação aos agentes.

  • casting_time (string, date-time): hora em que a UJET ofereceu a ligação.

  • group (string): grupo a que a UJET ofereceu a chamada.

Outros detalhes

• answer_type (string ou nulo): como a chamada foi resolvida ("manual" ou "automática").

• outbound_number (string ou null): número de telefone de saída usado.

• wait_time_sms (matriz; presente apenas quando interações por SMS de tempo de espera ocorreram nesta chamada): interações por SMS que a UJET enviou ao consumidor sobre o tempo de espera esperado. Cada entrada contém:

  • transfer_id (inteiro ou nulo): identificador do evento de transferência, se associado a uma transferência.

  • status (string): status do SMS. Valores possíveis: not_triggered, triggered, triggered_allowed, triggered_denied, triggered_no_selection, triggered_sent, triggered_failed.

  • received (booleano): indica se o consumidor recebeu o SMS.

• in_call_sms (matriz; presente apenas quando interações por SMS durante a chamada ocorreram nela): interações por SMS durante a chamada. Cada entrada contém:

  • transfer_id (inteiro ou nulo): identificador do evento de transferência, se associado a uma transferência.

  • preset_sent (booleano): indica se a UJET enviou uma mensagem predefinida.

  • custom_sent (booleano): indica se o agente enviou uma mensagem personalizada (texto livre).

  • received (booleano): indica se a UJET recebeu um SMS do consumidor.

• dispositions (matriz; presente apenas quando você ativa os códigos de finalização ou observações na sua conta): códigos de finalização e observações gravados pelos agentes. Cada entrada inclui campos renderizados dinamicamente com base na configuração da finalização:

  • user_id (inteiro): identificador do agente.

  • transfer_id (inteiro ou nulo): identificador do evento de transferência, se registrado após uma transferência.

  • participant_id (inteiro): identificador do participante.

  • note (string): observação de texto livre do agente.

  • original_note (string): versão original (antes da edição) da anotação.

  • code (string): codinome de disposição.

  • ujet_code_id (inteiro ou string vazia): o ID do UJET do código de disposição, uma chave estável para o código (o nome de exibição do código pode mudar). String vazia quando não disponível.

  • list (string): nome da lista a que o código pertence.

  • list_path (string): caminho separado por barras da lista de códigos.

  • ujet_list_id (número inteiro ou string vazia): o ID do UJET da lista a que o código de disposição pertence, uma chave estável para a lista. String vazia quando indisponível.

  • custom_list_id (string ou inteiro): identificador da lista definida pelo cliente, se mapeada.

  • custom_code_id (string ou inteiro): identificador de código definido pelo cliente, se mapeado.

• email (string, e-mail ou nulo): endereço de e-mail do consumidor.

• feedback (string ou nulo): feedback do consumidor.

• smart_action_text (string ou nulo): texto de qualquer ação inteligente realizada.

• custom_data_secured (objeto ou nulo): dados personalizados e assinados com segurança.

• custom_data_not_secured (objeto ou nulo): dados personalizados e não assinados de forma segura.

• in_queue_wait_time_va (matriz; presente apenas quando você ativa o acompanhamento do tempo de espera na fila para agentes virtuais na sua conta e quando ocorre pelo menos um encaminhamento de VA preservado): intervalos de tempo em que o consumidor esperou na fila enquanto a UJET preservava um agente virtual para ele após o encaminhamento. Cada entrada contém:

  • start (string, data e hora): quando a espera na fila começou.

  • end (string, data e hora ou nulo): quando a espera na fila terminou. Nulo se não foi concluída.

  • duration (inteiro ou nulo): duração da espera em segundos; nulo quando end é nulo.

• auto_session_summaries (matriz; presente apenas quando você ativa o resumo da conversa na sua conta e o UJET gera um resumo): resumos de sessão gerados por IA que o UJET salva no registro do CRM. Cada entrada contém:

  • user_id (inteiro): identificador do participante agente a que o resumo está associado.

  • participant_id (inteiro): identificador do participante.

  • session_summary (string): o texto do resumo.

  • session_summary_sections (matriz ou objeto): o resumo em seções estruturadas, se disponível.

• sip_headers (objeto; presente apenas quando você ativa a captura de cabeçalho SIP na sua conta e a configura para inclusão nos metadados da sessão): cabeçalhos SIP de entrada que o UJET capturou para a chamada. As chaves e os valores refletem os cabeçalhos SIP recebidos do provedor de telefonia upstream.

Definições

Esta seção define cada subesquema uma vez. Os grupos de propriedades que referenciam os subesquemas se vinculam a essas definições em vez de redefinir as formas inline.

menu_path (objeto)

Descreve um caminho de menu hierárquico percorrido pela chamada. Consulte Navegação no menu para ver a lista completa de campos.

Referenciado de: o campo menu_path de nível superior; cada transfers[].from_menu_path e transfers[].to_menu_path; cada escalations[].from_menu_path e escalations[].to_menu_path; cada deflection_details[].from_menu_path e deflection_details[].to_menu_path.

agent (objeto)

Descreve um agente humano. Esse objeto é uma das duas variantes do discriminador agent_info de nível superior. Consulte Raiz do esquema. Consulte Informações do agente e do agente virtual para conferir a lista completa de campos.

Referenciado de: o campo agent_info quando um atendente humano atendeu a chamada por último; cada transfers[].from_agent e transfers[].to_agent; cada escalations[].to_agent.

virtual_agent (objeto)

Descreve um agente virtual. Esse objeto é uma das duas variantes do discriminador agent_info de nível superior. Consulte Raiz do esquema. Consulte Informações do agente e do agente virtual para conferir a lista completa de campos.

Referenciado de: o campo agent_info quando um agente virtual atendeu a ligação por último; cada transfers[].from_virtual_agent e transfers[].to_virtual_agent; cada escalations[].from_virtual_agent; cada virtual_agent_handle_durations[].virtual_agent; cada virtual_agent_deflected_escalations[].virtual_agent.

deflection (string, enum)

O estado de rejeição de uma chamada ou segmento de chamada. Os valores seguem um padrão de nomenclatura <trigger>_<destination>, em que o prefixo identifica a condição que acionou o desvio (por exemplo, capacidade excedida, fora do horário de atendimento ou redirecionamento temporário), e o sufixo identifica o destino ou o tratamento (por exemplo, caixa postal, fila, telefone ou mensagem).

Sufixos de destino comuns:

• _phone: encaminha a chamada para um número de telefone externo.

• _voicemail: direciona a chamada para o correio de voz.

• _message: reproduz uma mensagem informativa.

• _message_only: reproduz uma mensagem e encerra a chamada sem mais encaminhamentos.

• _callback: oferece uma chamada de retorno programada.

• _wait: mantém o autor da chamada em espera.

• _queue: coloca a chamada em outra fila.

• _sip: encaminha a chamada para um destino SIP.

• _extension: encaminha a chamada para uma extensão.

• _phone_with_extension: encaminha a chamada para um destino de telefone com uma extensão.

Valores permitidos, agrupados por família de acionadores:

• Sem deflexão: no_deflection, deflecting.

• Excesso de capacidade: quando a fila excedeu o limite de capacidade: over_cap_phone, over_cap_voicemail, over_cap_callback, over_cap_wait, over_cap_queue, over_cap_message, over_cap_sip, over_cap_extension, over_cap_phone_with_extension.

• Fora do horário de expediente: quando a ligação chegou fora do horário de funcionamento configurado do menu: after_hours_voicemail, after_hours_phone, after_hours_message_only, after_hours_queue, after_hours_message, after_hours_sip, after_hours_extension, after_hours_phone_with_extension.

• Redirecionamento temporário: quando você configura um redirecionamento temporário no menu: temp_redirection_phone, temp_redirection_message, temp_redirection_voicemail, temp_redirection_queue, temp_redirection_sip, temp_redirection_extension, temp_redirection_phone_with_extension.

• Pré-sessão da URA: ivr_presession_deflection.

• Iniciada pelo agente virtual: quando um agente virtual redirecionou ou transferiu a chamada: va_redirection_phone, va_redirection_sip, va_third_party_phone, va_third_party_sip.

• Chamada interna fora do horário de expediente: internal_call_after_hours_message, internal_call_after_hours_queue, internal_call_after_hours_phone, internal_call_after_hours_extension, internal_call_after_hours_sip, internal_call_after_hours_voicemail.

• Excesso de capacidade de chamada interna: internal_call_over_capacity_message, internal_call_over_capacity_queue, internal_call_over_capacity_phone, internal_call_over_capacity_extension, internal_call_over_capacity_sip, internal_call_over_capacity_voicemail, internal_call_over_capacity_wait.

• Redirecionamento automático de chamadas internas: internal_call_automatic_redirection_message, internal_call_automatic_redirection_queue, internal_call_automatic_redirection_phone, internal_call_automatic_redirection_extension, internal_call_automatic_redirection_sip, internal_call_automatic_redirection_voicemail.

• Transferência de chamadas fora do horário de expediente: call_transfer_after_hours_message, call_transfer_after_hours_queue, call_transfer_after_hours_phone, call_transfer_after_hours_extension, call_transfer_after_hours_sip, call_transfer_after_hours_voicemail.

• Excesso de capacidade de transferência de chamadas: call_transfer_over_capacity_message, call_transfer_over_capacity_queue, call_transfer_over_capacity_phone, call_transfer_over_capacity_extension, call_transfer_over_capacity_sip, call_transfer_over_capacity_voicemail, call_transfer_over_capacity_wait.

• Redirecionamento automático de transferência de chamadas: call_transfer_automatic_redirection_message, call_transfer_automatic_redirection_queue, call_transfer_automatic_redirection_phone, call_transfer_automatic_redirection_extension, call_transfer_automatic_redirection_sip, call_transfer_automatic_redirection_voicemail.

• Desligamento de emergência: quando um administrador acionou um desligamento de emergência: emergency_shutdown, emergency_shutdown_message, emergency_shutdown_after_hours, emergency_shutdown_over_capacity.

• Encaminhamento dinâmico de chamadas (DCR): dcr_transferred, dcr_missed, dcr_redirected, dcr_finished.

Referenciado de: o campo deflection de nível superior, cada deflection_details[].deflection e cada transfers[].deflection.

Controle de versões e suspensões de uso

O esquema de metadados da sessão de chamada é compatível com a evolução de versões anteriores. A UJET pode adicionar novos campos e matrizes a qualquer momento. As integrações precisam ignorar chaves desconhecidas para garantir a funcionalidade contínua. Os campos nesta seção são descontinuados, legados ou substituídos de forma parcial. Eles permanecem no payload para compatibilidade com versões anteriores, mas novas integrações precisam seguir as orientações de cada campo.

Campos descontinuados

• voip_provider (string): descontinuado. Sempre retorna a string literal "deprecated". A UJET não mostra mais informações do provedor para integrações neste documento. Não há um campo de substituição. Se a integração precisar identificar o provedor de telefonia upstream, entre em contato com sua equipe de conta.

Duplicatas legadas

• session_type (string): alias legado de call_type. Sempre retorna o mesmo valor de call_type e usa o mesmo vocabulário de enumeração legada. O UJET retém esse campo para compatibilidade com versões anteriores com integrações que usam session_type como chave. As novas integrações precisam analisar call_type diretamente ou, para distinções de entrada mais refinadas, session_type_v2 (consulte Evolução do vocabulário abaixo).

Evolução do vocabulário

call_type e session_type_v2 descrevem o mesmo tipo de chamada usando dois vocabulários diferentes. O UJET emite os dois campos em todos os registros. Eles não são duplicados um do outro:

• call_type usa o vocabulário de enumeração legado. Valores como Voice Inbound (App) e Voice Inbound (IVR using App) abrangem todas as origens de SDKs para dispositivos móveis e no app em um único rótulo. call_type não está descontinuado. O UJET vai continuar emitindo esse campo, mas o vocabulário dele não vai receber novos valores refinados.

• session_type_v2 usa o vocabulário de enumeração atual. Ele apresenta distinções de entrada mais refinadas, por exemplo, Voice Inbound (Mobile) e Voice Inbound (IVR using Mobile), para os tipos de chamada que têm valores específicos da v2. Para tipos de chamada que não têm um valor específico da v2, session_type_v2 retorna a mesma string que call_type.

As novas integrações precisam analisar session_type_v2. Os valores de cada campo estão listados em Informações principais.

Nomenclatura do campo de tempo de espera

O documento de metadados da sessão de chamada informa o tempo de espera na fila em dois escopos, com dois nomes de campo:

• Total de chamadas: o campo wait_duration de nível superior contém o tempo total que o consumidor passou na fila durante toda a chamada.

• Por segmento: cada entrada na matriz queue_durations de nível superior (Durações da fila) tem o próprio campo queue_duration, que contém o tempo de espera do segmento de fila individual.

Ambos os nomes se referem ao mesmo tipo de medição (tempo gasto na fila) em escopos diferentes. O total de chamadas wait_duration reflete o tempo total de espera do consumidor, enquanto os valores queue_duration por segmento descrevem cada segmento da fila. Este documento não emite um campo queue_duration de nível superior separado. Os valores por segmento estão disponíveis apenas em queue_durations.