Metadados da sessão de chat

Este documento descreve o esquema do registro de metadados da sessão de chat. O registro de metadados é o documento JSON que a Contact Center AI Platform cria para uma sessão de chat de suporte. A CCAI Platform envia o registro de metadados para sua integração de CRM como parte do comando session-end do chat. Quando você ativa o armazenamento externo, a plataforma CCAI também grava o registro na configuração de armazenamento externo usando um arquivo metadata.json. Cada conversa gera um registro, que o id de nível superior identifica de forma 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 chat é um único objeto JSON que representa uma sessão de chat. Três conceitos no nível superior determinam a identidade e a forma do registro.

Chave primária: id (inteiro)

Identifica exclusivamente a sessão de chat no seu locatário. Há um registro por conversa. Todos os outros campos de nível superior, matrizes e objetos aninhados descrevem atributos da conversa que este id identifica.

Discriminador de gerenciador: agent_info (objeto, oneOf)

Um único objeto cuja forma varia dependendo do último manipulador do chat. As duas variantes são mutuamente exclusivas. Apenas uma delas está presente:

  • Variante humano-agente: presente quando o último manipulador do chat foi um agente humano. 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 quando o último manipulador do chat foi um agente virtual. 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. As definições completas de cada variante aparecem em Definições: agent e Definições: virtual_agent.

Discriminadores de formato de chat: chat_type, session_type, session_type_v2 (string)

Três visualizações paralelas do mesmo tipo de chat. Eles nunca discordam sobre qual tipo de chat um registro representa, apenas no vocabulário usado para nomeá-lo.

  • chat_type: usa o vocabulário de enumeração legado, como "Mensagens recebidas (chat do app)", "Mensagens (SMS)" e "Mensagens (WhatsApp)".

  • session_type: sempre retorna a mesma string que chat_type. Ele existe para compatibilidade com versões anteriores com integrações que usam esse campo como chave. Trate-o como um alias descontinuado de chat_type.

  • session_type_v2: usa o vocabulário de enumeração atual, que pode incluir distinções mais refinadas, como "Mensagens recebidas (chat para dispositivos móveis)". Para tipos de chat que não têm um valor específico da v2, session_type_v2 retorna a mesma string que chat_type. As novas integrações precisam analisar session_type_v2.

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

Informações principais

  • id (número inteiro): um identificador exclusivo para cada sessão de chat. Essa chave primária distingue um chat de outro.

  • lang (string): o código de idioma ISO 639 usado durante a conversa (por exemplo, "en" para inglês, "es" para espanhol).

  • chat_type (string): o tipo de chat, usando o vocabulário de tipo legado. Os valores incluem "Messaging Inbound (App Chat)", "Messaging Inbound (Web Chat)", "Messaging (SMS)", "Messaging (WhatsApp)" e "Messaging (Apple Messaging for Business)".

  • session_type (string): um duplicado de chat_type (mesmos valores), mantido para compatibilidade com versões anteriores. Consulte Controle de versões e descontinuações: duplicatas legadas.

  • session_type_v2 (string): o tipo de conversa, usando o vocabulário atual. Ele refina os valores chat_type com distinções mais refinadas. Os valores incluem "Messaging Inbound (Mobile Chat)", "Messaging Inbound (Web Chat)", "Messaging (WhatsApp)", "Messaging (Apple Messaging for Business)", "Messaging (SMS)", "Messaging Inbound (SMS)", "Messaging Outbound (SMS)", "Messaging Outbound (SMS using the API)", "Messaging Inbound (SMS Direct)", "Messaging Outbound (SMS Direct)" e "Messaging Outbound (SMS Direct using the API)".

  • status (string): o status atual da conversa. Valores possíveis: "queued", "selecting", "assigned", "va_assigned", "dismissed", "va_dismissed", "check_in_timeout", "finished", "no_response", "canceled" e "failed". (A plataforma CCAI informa um chat concluído que não recebeu resposta do consumidor como "no_response".)

  • sub_status (string ou nulo): detalhes mais específicos sobre o status da conversa, quando disponíveis. Valores possíveis: "selecting", "queued", "ongoing", "dismissed", "finished", "timeout", "deflected", "abandoned", "expired", "failed", "disconnected_by_agent", "disconnected_by_end_user", "no_messages", "no_messages_disconnected_by_agent", "no_messages_disconnected_by_end_user" e "end_user_opt_out".

  • created_at (string, data e hora): o carimbo de data/hora em que a plataforma CCAI criou a sessão de chat.

  • assigned_at (string, data/hora ou nulo): o carimbo de data/hora em que a plataforma CCAI atribuiu o chat a um agente ou nulo se ele não foi atribuído.

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

  • updated_at (string, data e hora): o carimbo de data/hora da última atualização dos dados de chat pela CCAI Platform.

  • first_msg_sent_at (string, data/hora ou nulo): o carimbo de data/hora em que um participante enviou a primeira mensagem no chat.

  • last_msg_sent_at (string, data/hora ou nulo): o carimbo de data/hora em que um participante enviou a última mensagem no chat.

  • wait_duration (número inteiro): o tempo total que o consumidor passou esperando, em segundos.

  • chat_duration (número inteiro): a duração total da conversa, em segundos.

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

  • rating (inteiro ou nulo): a classificação de satisfação do cliente (CSAT) fornecida pelo consumidor ou nula se ele não deu uma classificação.

  • has_feedback (booleano): indica se o consumidor enviou feedback após a conversa.

  • out_ticket_id (string ou nulo): o identificador do tíquete que a plataforma CCAI criou 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 por chat (falso).

  • fail_reason (string): o motivo de qualquer falha durante o chat ou "nothing" quando o chat não falhou. Valores possíveis: "nothing", "unknown", "expired", "after_hours", "escalation_failed", "check_in_timed_out", "check_in_timed_out_expired", "expired_menu_selection", "end_user_opt_out", "over_cap_email", "group_deleted_no_substitute", "presession_deflection_unknown", "presession_deflection_timeout", "presession_deflection_message_delivery_failed", "sms_error" e "force_ended".

  • provider_type (string): o tipo de provedor de chat usado. Valores possíveis: "unknown", "messaging", "twilio_conversations", "nexmo_conversations" e "ujet_conversations".

  • provider_channel_id (string ou nulo): identificador de canal específico do provedor para o chat.

  • message_count (inteiro): o número total de mensagens trocadas no chat.

  • average_response_time (número inteiro): o tempo médio que os agentes levaram para responder durante o chat, em segundos.

  • longest_response_time (número inteiro): o tempo máximo que um agente levou para responder durante o chat, em segundos.

  • transcript (booleano): indica se há uma transcrição de chat para a sessão.

Informações do agente e do agente virtual

  • agent_info (objeto): informações sobre o agente humano ou agente virtual que processou o chat por último. Esse campo usa a palavra-chave oneOf para especificar que pode ser 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 ou null): 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 um estiver configurado. Sempre presente no payload. É nulo quando nenhum alias está definido.

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

    • 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 (inteiro ou nulo): a posição do menu em relação a outros menus no mesmo nível.

    • deleted (booleano): indica se um administrador excluiu o menu.

    • menu_type (string): o tipo de menu (por exemplo, "sms_menu", "web_menu").

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

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

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

    • name (string ou nulo): uma string separada por barras com nomes de menus (por exemplo, "Support/Billing") ou nulo se o caminho do menu não estiver disponível.

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

  • queue_priority_level (inteiro): a prioridade da fila atribuída à fila selecionada do chat. Presente apenas quando a prioridade da fila está ativada na sua conta.

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.

Flags do cliente e dados fornecidos pelo SDK

  • customer_flag (objeto): flags que marcam atributos notáveis do consumidor fornecidos ou atualizados por sistemas externos durante a sessão. Presente apenas quando sistemas externos fornecem ou atualizam flags do cliente relacionadas à autenticação durante a sessão.

    • verified_customer (booleano): indica se um sistema externo marcou o consumidor como verificado.

    • bad_actor (booleano): indica se um sistema externo sinalizou o consumidor como um usuário de má-fé.

    • repeat_customer (booleano): indica se um sistema externo marcou o consumidor como cliente recorrente.

  • custom_data_secured (objeto ou nulo): dados personalizados e assinados com segurança que o SDK ou a API Apps forneceu.

  • custom_data_not_secured (objeto ou nulo): dados personalizados e não assinados de forma segura fornecidos pelo SDK ou pela API Apps.

  • sip_headers (objeto): cabeçalhos SIP de entrada capturados para o chat. As chaves e os valores refletem os cabeçalhos SIP recebidos do provedor upstream. Presente somente quando você ativa a captura de cabeçalho SIP na sua conta e a configura para aparecer nos metadados da sessão

Anexos de mídia

  • photos (matriz): fotos ou capturas de tela associadas à conversa.

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

    • photo_type (string): o tipo de foto. Os valores possíveis incluem "photo" e "screenshot".

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

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

    • transfer_id (número inteiro ou nulo): identificador do evento de transferência associado à foto, se um participante fez upload dela após uma transferência concluída.

  • videos (matriz): vídeos associados ao chat.

    • 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 associada ao vídeo, se houver.

    • transfer_id (número inteiro ou nulo): identificador do evento de transferência associado ao vídeo, se um participante fez upload dele após uma transferência concluída.

Transferências de chat

  • transfers (matriz): uma entrada por evento de transferência durante o chat. Registra transferências entre atendentes, agentes virtuais e menus.

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

    • status (string): status atual da transferência. Os valores possíveis incluem "transferring", "transferred", "failed" e "deflected".

    • fail_reason (string): motivo da falha na transferência ou "nothing" se não houve falha. Valores possíveis: "nothing", "timeout", "canceled", "ag_connection_timeout", "va_failure", "agent_detection_missed", "unknown" e "unreachable_phone_number".

    • created_at (string, data e hora): carimbo de data/hora em que a transferência começou.

    • assigned_at (string, data/hora ou nulo): carimbo de data/hora em que a plataforma de CCAI atribuiu a transferência.

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

    • updated_at (string, data/hora ou nulo): carimbo de data/hora em que a plataforma CCAI atualizou o registro de transferência pela última vez.

    • call_duration (número inteiro ou nulo): duração do segmento de conversa transferido, em segundos.

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

    • deflection (string): tipo de rejeição associado à transferência. Consulte Definições: deflection para conferir os valores permitidos.

    • answer_type_path (string ou nulo): caminho que descreve como os agentes ou menus responderam aos chats de origem e destino.

    • 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.

Durações do atendimento por chat

  • handle_durations (matriz): uma matriz de objetos, cada um representando um segmento da conversa processada por um agente.

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

    • agent_id (inteiro ou nulo): identificador do agente.

    • acw_duration (inteiro): duração do trabalho após o chat, em segundos.

    • chat_duration (número inteiro): duração da conversa durante esse segmento, em segundos.

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

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

    • lang (string): idioma usado.

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

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

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

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

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

    • response_time_total (número inteiro): tempo total de resposta do agente, em segundos.

    • response_time_max (número inteiro): maior tempo de resposta do agente, em segundos.

    • response_time_avg (número ou nulo): tempo médio de resposta do agente, em segundos. Esse valor pode incluir precisão decimal.

    • assigned_connection_duration (número inteiro): duração da espera do consumidor enquanto o agente atribuído se conectava durante esse segmento.

Durações na fila

  • queue_durations (matriz): uma matriz de objetos, cada um representando um segmento da conversa em que o consumidor estava esperando em uma fila.

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

    • agent_id (inteiro ou nulo): identificador do agente.

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

    • lang (string): idioma.

    • menu_path_id (número inteiro ou nulo): identificador do caminho do menu.

    • menu_path (string): caminho do menu.

    • queue_duration (número inteiro ou nulo): duração da fila, em segundos.

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

    • transfer_cold (booleano ou nulo): indica se a conversa foi transferida a frio.

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

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

    • service_level_abandon_time_threshold (número inteiro): limite de abandono do nível de serviço, em segundos.

    • service_level_event (string): status do evento de nível de serviço. Os valores possíveis incluem "excluded", "in_sla" e "not_in_sla".

    • service_level_target_percent (número inteiro): porcentagem da meta de nível de serviço.

    • service_level_target_time (inteiro): tempo de meta de nível de serviço, em segundos.

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 do encaminhamento para um supervisor. Valores possíveis: "escalating", "escalated", "canceled", "deflecting" e "deflected".

    • reason (string): motivo do encaminhamento do chat. Valores possíveis: "unknown", "by_end_user_ask", "by_end_user_message", "by_virtual_agent", "payload_failure", "could_not_resume", "by_human_agent", "invalid_queue" e "dismissed".

    • created_at (string, data e hora): carimbo de data/hora em que a escalonamento começou.

    • escalated_at (string, data/hora ou nulo): carimbo de data/hora em que a escalonamento foi concluído.

    • from_virtual_agent (objeto ou nulo): agente virtual que encaminhou a conversa. Tem o mesmo formato do objeto virtual_agent em Definitions.

    • to_agent (objeto ou nulo): agente humano para quem o chat foi encaminhado. 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 evitados pelo agente virtual

  • virtual_agent_deflected_escalations (matriz): detalhes dos encaminhamentos de agentes virtuais que foram desviados para outro destino.

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

    • deflection (string): tipo de rejeição da escalonamento rejeitado. Valores possíveis: "no_deflection", "over_cap", "over_cap_email", "over_cap_virtual_agent", "over_cap_human_agent", "over_cap_sip", "over_cap_extension", "after_hours", "after_hours_email" e "after_hours_virtual_agent".

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

    • escalation_reason (string): motivo do encaminhamento. Os mesmos valores de escalations[].reason (consulte 10. Virtual-agent-to-human escalations).

    • 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: virtual_agent.

Durações de atendimento do agente virtual

  • virtual_agent_handle_durations (matriz): segmentos de tempo em que o chat foi tratado por um agente virtual.

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

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

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

    • escalation_reason (string): motivo do encaminhamento.

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

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

    • response_time_total (número inteiro): tempo total de resposta do agente virtual, em segundos.

    • response_time_max (número inteiro): o maior tempo de resposta do agente virtual, em segundos.

    • response_time_avg (número ou nulo): tempo médio de resposta do agente virtual, em segundos. Esse valor pode incluir precisão decimal.

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

    • initiated_by (string): como a sessão do agente virtual foi iniciada. Valores possíveis: "end_user", "human_agent" e "post_session".

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

    • menu_path (string): caminho do menu.

    • lang (string): idioma.

    • transfer (booleano): indica se o chat foi transferido.

    • 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 e hora): carimbo de data/hora de término.

Durações do atendimento ao consumidor

  • consumer_handle_durations (matriz): durações em que o consumidor estava no chat.

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

    • chat_duration (inteiro): duração do segmento de consumidor, em segundos.

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

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

    • message_count (número inteiro): número de mensagens do consumidor.

    • response_count (número inteiro): número de respostas do consumidor.

    • response_time_total (número inteiro): tempo total de resposta do consumidor, em segundos.

    • response_time_max (número inteiro): maior tempo de resposta do consumidor, em segundos.

    • response_time_avg (número inteiro): tempo médio de resposta do consumidor, em segundos.

Durações de eventos do consumidor

  • consumer_event_durations (matriz): detalhes dos eventos de chat do consumidor (por exemplo, CSAT, pagamento).

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

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

    • type (string): tipo de evento. Valores possíveis: "csat".

    • event (string): resultado do evento. Valores possíveis: "finished" e "abandoned".

    • 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 do chat (por exemplo, usuário final, agente, agente virtual).

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

    • type (string): tipo de participante. Valores possíveis: "end_user", "agent", "manager", "virtual_agent", "external_agent" e "task_virtual_agent".

    • entry_type (string): como o participante entrou no chat. Valores possíveis: "queue_or_transfer", "barge" e "post_session".

    • 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): metadados personalizados usados pelo agente virtual. Presente apenas quando você configura a inclusão de metadados personalizados do agente virtual.

    • status (string): status do participante. Valores possíveis: "waiting", "connecting", "invited", "connected", "wrapping_up", "finished", "failed", "resuming" e "post_session_in_progress".

    • fail_reason (string): motivo da falha, se houver. Valores possíveis: "nothing", "canceled", "ag_connection_timeout" e "unknown".

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

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

    • chat_id (número inteiro): identificador do chat.

    • chat_duration (inteiro ou nulo): duração do chat para o participante, em segundos.

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

    • agent_assist (objeto): configurações do Agent Assist ativas para o participante. Sempre presente; um objeto padrão vazio quando o Agent Assist não está configurado.

    • virtual_agent (objeto ou nulo): detalhes do agente virtual que atua como este participante. É diferente do agent_info de nível superior e do virtual_agent_params.

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

    • location (string ou nulo): o local configurado do agente. Presente apenas em participantes do agente.

    • location_id (inteiro ou nulo): o identificador do local. Apresentar apenas para participantes do agente.

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

    • first_name (string ou nulo): o primeiro nome do agente. Apresente apenas para participantes agentes.

    • last_name (string ou nulo): o sobrenome do agente. Apresente apenas para participantes agentes.

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

    • teams (matriz): matriz de objetos { id, name } que descrevem as equipes a que o agente pertence. Presente apenas em participantes agentes.

Registros de check-in

  • check_in_logs (matriz): eventos de check-in registrados durante a sessão de chat. Cada item agrupa eventos de check-in para um fluxo de check-in.

    • check_in_id (inteiro): identificador do fluxo de check-in.

    • check_in_modal_displayed (string, data e hora): carimbo de data/hora em que a plataforma CCAI mostrou o modal de check-in ao consumidor. Presente apenas quando a plataforma de CCAI mostrou a caixa de diálogo de check-in.

    • check_in_modal_confirmed (string, data/hora): carimbo de data/hora em que o consumidor confirmou que ainda estava presente. Presente apenas quando o consumidor confirmou o modal de check-in.

    • check_in_modal_timed_out (string, data e hora): carimbo de data/hora em que o comando de check-in expirou. Presente somente quando o modal de check-in expira.

    • timeout_modal_rejoin_success (string, data/hora): carimbo de data/hora em que a ação de reingresso foi concluída. Presente apenas quando o consumidor se reconecta após o tempo limite.

    • timeout_modal_rejoin_failed_after_hour (string, data e hora): carimbo de data/hora em que a ação de nova participação falhou devido ao comportamento fora do horário de expediente. Presente apenas quando a nova entrada falhou porque a fila estava fora do horário de funcionamento.

    • timeout_modal_exit_chat (string, data/hora): carimbo de data/hora em que o consumidor escolheu sair do chat. Presente apenas quando o consumidor saiu do chat pelo modal de tempo limite.

    • timeout_modal_time_out_sdk_closed (string, data e hora): carimbo de data/hora de quando o fluxo modal de tempo limite terminou porque o SDK foi fechado. Presente somente quando o SDK é fechado após o tempo limite.

Oferecer eventos

  • offer_type (string ou nulo): maneira como a plataforma CCAI ofereceu o chat ao agente.

  • offer_events (matriz): eventos em que a plataforma CCAI ofereceu o chat aos agentes.

    • casting_time (string, data e hora): horário em que a plataforma CCAI ofereceu o chat.

    • group (string): grupo para o qual a plataforma CCAI ofereceu o chat.

Outros detalhes

  • dismiss_duration (número inteiro): duração do chat no status dispensado, em segundos. Presente somente quando o chat ficou no status "dispensado".

  • answer_type (string ou nulo): como o chat foi respondido. Valores possíveis: "manual", "auto", "outbound" e "deflection".

  • inbound_number (string): número de telefone de entrada associado ao chat. Presente apenas quando um número de telefone de entrada está associado ao chat.

  • outbound_number (string): número de telefone de saída associado ao chat. Presente apenas quando um número de telefone de saída está associado à conversa.

  • after_hours (booleano): se o chat ocorreu fora do horário comercial.

  • dispositions (matriz): códigos e observações de finalização gravados pelos agentes. Presente apenas quando você ativa os códigos de finalização ou as observações na sua conta. Cada entrada pode conter campos renderizados condicionalmente com base na sua configuração de 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 (número inteiro ou string vazia): o identificador do código de disposição atribuído pela plataforma CCAI, uma chave estável para o código (o nome de exibição do código pode mudar). String vazia quando indisponí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 (inteiro ou string vazia): o identificador atribuído pela plataforma CCAI 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.

  • auto_session_summaries (matriz): resumos de sessões gerados por IA salvos no registro do CRM. Presente apenas quando você ativa o resumo da conversa na sua conta e a IA gera um resumo. 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 dividido em seções estruturadas, quando disponível.

  • transfer_limit (objeto ou nulo): dados do limite de transferência para o chat.

    • enabled (booleano): indica se o rastreamento do limite de transferência foi ativado para a conversa.

    • limit_count (inteiro): número de baldeações permitidas.

    • limit_reached (booleano): indica se o chat atingiu o limite de transferência configurado.

  • email (string, e-mail ou nulo): o 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.

Definições

Os subesquemas a seguir aparecem em vários pontos do documento de metadados da sessão de chat. Cada subesquema aparece uma vez. Os grupos de propriedades que os referenciam apontam de volta para esta seção em vez de redefinir a forma inline.

Descreve um caminho de menu hierárquico percorrido pelo chat. 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.

agent (objeto)

Descreve um agente humano. Essa é uma das duas variantes do discriminador de nível superior agent_info (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 o último manipulador do chat era um agente humano; cada transfers[].from_agent e transfers[].to_agent; cada escalations[].to_agent.

virtual_agent (objeto)

Descreve um agente virtual. Essa é uma das duas variantes do discriminador de nível superior agent_info (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 o último manipulador do chat era um agente virtual; 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; cada participants[].virtual_agent.

deflection (string, enum)

O estado de recusa associado a uma transferência. Os valores seguem um padrão <trigger>_<destination>, em que o prefixo identifica a condição que acionou a rejeição e o sufixo identifica o destino ou o tratamento (por exemplo, _phone, _voicemail, _message, _queue, _sip, _extension, _callback, _wait).

Valores permitidos, agrupados por família de gatilhos:

  • Nenhuma 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_message, over_cap_ewt_only, over_cap_queue, over_cap_sip, over_cap_extension, over_cap_phone_with_extension

  • Fora do horário de atendimento, quando o chat chegou fora do horário de funcionamento configurado do menu: after_hours_voicemail, after_hours_phone, after_hours_message_only, after_hours_message, after_hours_queue, after_hours_sip, after_hours_extension, after_hours_phone_with_extension

  • Redirecionamento temporário, quando um redirecionamento temporário foi configurado 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

  • Redirecionamento de agente virtual, quando um agente virtual redirecionou o chat: va_redirection_phone, va_redirection_sip

Referenciado de: cada transfers[].deflection. (As escalações desviadas pelo agente virtual em Escalações desviadas pelo agente virtual usam um vocabulário de desvio separado e menor, documentado inline ali.)

transfer (objeto)

Descreve uma transferência que ocorreu durante o chat. Uma transferência pode mover um chat entre menus, agentes e agentes virtuais. Consulte Transferências de chat para ver a lista completa de campos.

Referenciado de:a matriz transfers de nível superior. Outros campos chamados transfer_id ao longo do documento são referências inteiras ao id de uma transferência, não objetos transfer inline.

participant (objeto)

Descreve um participante do chat. O formato do participante varia de acordo com o tipo. Os participantes agentes podem incluir perfil, local, equipe e campos do Assistente de agente, enquanto os participantes consumidores e agentes virtuais incluem identificadores específicos do tipo. Consulte Participantes para ver a lista completa de campos documentados.

Referenciado de:a matriz de nível superior participants; auto_session_summaries[].participant_id; registros de disposição.

Linha de duração (objeto)

Descreve um intervalo medido no chat, como tempo de atendimento do agente, tempo de espera na fila, tempo de atendimento do cliente, tempo de evento do cliente ou tempo de atendimento do agente virtual. Cada matriz de duração tem um formato de linha próprio porque campos com nomes semelhantes podem ter precisão ou capacidade de aceitar valores nulos diferentes em várias tabelas.

Referenciado de: handle_durations, queue_durations, virtual_agent_handle_durations, consumer_handle_durations e consumer_event_durations.

Controle de versões e suspensões de uso

O documento de metadados da sessão de chat foi projetado para evolução de esquema compatível com versões anteriores. Novos campos e matrizes podem ser adicionados a qualquer momento, e as integrações precisam ignorar chaves não reconhecidas para garantir a funcionalidade contínua. Os campos a seguir são legados ou foram 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 um.

Duplicatas legadas

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

Evolução do vocabulário

chat_type e session_type_v2 descrevem o mesmo tipo de chat com dois vocabulários diferentes. A plataforma CCAI emite os dois campos em todos os registros, e eles não são duplicados:

  • chat_type usa o vocabulário de enumeração legado. Valores como "Mensagens recebidas (chat no app)" e "Mensagens (SMS)" descrevem as categorias originais de tipo de chat.

  • session_type_v2 usa o vocabulário de enumeração atual. Ele pode introduzir distinções mais refinadas para os tipos de chat que têm valores específicos da v2. Para tipos de chat que não têm um valor específico da v2, session_type_v2 retorna a mesma string que chat_type.

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

Campos aditivos

A carga útil de metadados da sessão de chat pode ganhar novos campos de nível superior, campos aninhados, campos de itens de matriz ou valores de enumeração ao longo do tempo. As integrações precisam ignorar chaves não reconhecidas e preservar registros brutos sempre que possível. Evite a análise estrita que falha quando uma nova propriedade aparece.