Metadatos de la sesión de llamada

En este documento, se proporciona el esquema del registro de metadatos de la sesión de llamada, el documento JSON que UJET emite al final de cada llamada de voz. UJET entrega el registro a tu integración de CRM como el cuerpo del comando de finalización de la sesión y escribe el registro en tu configuración de almacenamiento externo como un archivo metadata.json. Cada llamada produce exactamente un registro. El id de nivel superior identifica de forma única cada registro. Usa este esquema para transferir registros a sistemas posteriores, validar cargas útiles recibidas o asignar campos a columnas de almacenes de datos.

Raíz del esquema

El registro de metadatos de la sesión de llamada es un solo objeto JSON que representa una sesión de llamada de voz. Tres conceptos de nivel superior determinan la identidad y la forma del registro.

Clave principal: id (número entero)

El id de nivel superior identifica de forma única la sesión de llamada dentro de tu arrendatario. Existe un registro por llamada. Todos los demás campos, arrays y objetos anidados de nivel superior describen atributos de la llamada que identifica este id.

Discriminador de controlador: agent_info (objeto, oneOf)

Es un solo objeto cuya forma varía según el último controlador de la llamada. Las dos variantes son mutuamente excluyentes: el registro contiene solo una variante:

• Variante de agente humano: Se presenta si un agente humano atendió la llamada por última vez. Incluye email, first_name, last_name y agent_number, además de los campos compartidos id, name y avatar_url.

• Variante del agente virtual: Se presenta si un agente virtual atendió la llamada al final. Incluye va_alias y omite email, first_name, last_name y agent_number.

Para detectar qué variante contiene un registro, verifica la presencia de un campo específico de la variante, por lo general, agent_info.email para la variante de agente humano o agent_info.va_alias para la variante de agente virtual. Para conocer la forma completa de cada variante, consulta agent y virtual_agent.

Discriminadores de forma de llamada: call_type, session_type, session_type_v2 (cadena)

Tres vistas paralelas del mismo tipo de llamada subyacente. Nunca discrepan sobre qué tipo de llamada representa un registro; solo difieren en el vocabulario que usan para nombrar el tipo de llamada.

• call_type usa el vocabulario de enumeración heredado (por ejemplo, Voice Inbound (App), Voice Outbound o Voice Internal).

• session_type siempre devuelve la misma cadena que call_type. UJET proporciona este campo para la compatibilidad con versiones anteriores de las integraciones que se basan en este campo. Trátalo como un alias obsoleto de call_type. Consulta Control de versiones y obsolescencia.

• session_type_v2 usa el vocabulario de enumeración actual. Este vocabulario extiende el vocabulario de call_type con distinciones entrantes más detalladas; por ejemplo, Voice Inbound (Mobile) y Voice Inbound (IVR using Mobile) en lugar de los más amplios Voice Inbound (App) y Voice Inbound (IVR using App). Para los tipos de llamadas que no tienen un valor específico de la versión 2, session_type_v2 devuelve la misma cadena que call_type. Las integraciones nuevas deben analizar session_type_v2.

Para conocer los valores de cada campo, consulta Información principal.

Información básica

Estas propiedades capturan la información principal de la llamada:

• id (número entero): Es un identificador único para cada sesión de llamada. Es la clave primaria que distingue una llamada de otra.

• call_uuid (cadena o nulo): Es un identificador único que correlaciona una llamada entre el origen y los arrendatarios receptores en las interacciones de enrutamiento dinámico de llamadas (DCR). Ambos tramos de una llamada de DCR comparten el mismo valor de call_uuid, lo que permite a los clientes unir datos entre entornos. El campo es nulo o está vacío para cualquier llamada que no sea una interacción de DCR y para las llamadas que se produjeron antes de que UJET agregara el campo.

• lang (cadena): Código de idioma ISO 639 de la llamada (por ejemplo, "en" para inglés o "es" para español). Este código te ayuda a realizar análisis y generar informes específicos para cada idioma.

• call_type (cadena): Es el tipo de llamada, que usa el vocabulario de tipo heredado. Los valores incluyen "Llamada entrante de voz (app)", "Llamada entrante de voz (web)", "Llamada entrante de voz (IVR)", "Llamada entrante de voz (IVR con app)", "Llamada entrante de voz (API)", "Llamada entrante de voz (directa)", "Llamada entrante de voz (extensión)", "Llamada programada de voz (app)", "Llamada programada de voz (web)", "Llamada programada de voz (API)", "Devolución de llamada de voz", "Devolución de llamada de voz (web)", "Llamada saliente de voz", "Llamada saliente de voz (API)", "Llamada saliente de voz (directa)", "Llamada saliente de voz (UCaaS)", "Llamada interna de voz", "Campaña de voz (Acqueon)", "Campaña de voz (<nombre de tu marca>)" y "Llamada programada por el agente".

• session_type (cadena): Es un duplicado de call_type (mismos valores) que UJET conserva para la retrocompatibilidad. Consulta Control de versiones y bajas: Duplicados heredados.

• session_type_v2 (cadena): Es el tipo de llamada, que usa el vocabulario de tipo actual. Refina los valores de call_type con distinciones entrantes más detalladas (por ejemplo, "Entrante de voz (dispositivos móviles)" y "Entrante de voz (IVR con dispositivos móviles)" en lugar de "Entrante de voz (app)" y "Entrante de voz (IVR con app)"). Los valores incluyen "Llamada entrante de voz (móvil)", "Llamada entrante de voz (Web)", "Llamada entrante de voz (IVR)", "Llamada entrante de voz (IVR con dispositivo móvil)", "Llamada entrante de voz (API)", "Llamada entrante de voz (directa)", "Llamada entrante de voz (extensión)", "Llamada programada de voz (móvil)", "Llamada programada de voz (Web)", "Llamada programada de voz (API)", "Devolución de llamada de voz", "Devolución de llamada de voz (Web)", "Llamada saliente de voz", "Llamada saliente de voz (API)", "Llamada saliente de voz (directa)", "Llamada saliente de voz (UCaaS)", "Llamada interna de voz", "Campaña de voz (Acqueon)", "Campaña de voz (<nombre de tu marca>)" y "Llamada programada del agente".

• status (cadena): Es el estado actual de la llamada. Los valores posibles son "scheduled", "queued", "connected", "finished", "failed" y "deflected". Esto hace un seguimiento del progreso de la llamada a lo largo de su ciclo de vida.

• created_at (cadena, fecha y hora): Es la marca de tiempo precisa en la que UJET creó el registro de la llamada.

• queued_at (cadena, fecha y hora o nulo): Es la marca de tiempo en la que la llamada ingresó a la cola o nulo si no ingresó.

• assigned_at (cadena, fecha y hora o nulo): Es la marca de tiempo en la que UJET asignó la llamada a un agente o nulo si UJET no asignó la llamada.

• connected_at (cadena, fecha y hora o nulo): Es la marca de tiempo en la que se conectó la llamada.

• ends_at (cadena, fecha y hora o nulo): Es la marca de tiempo en la que finalizó la llamada.

• scheduled_at (cadena, fecha y hora o nulo): Es la marca de tiempo en la que UJET programó la llamada o nulo si la llamada fue inmediata.

• updated_at (cadena, fecha y hora): Es la marca de tiempo en la que UJET actualizó por última vez los datos de la llamada.

• wait_duration (número entero o nulo): Es el tiempo total que el cliente pasó en la fila de espera durante toda la llamada, en segundos, o bien nulo si UJET no registró ningún tiempo de espera. Para ver el tiempo en la fila desglosado por segmento individual, consulta el array queue_durations (Duraciones de la fila). Consulta Control de versiones y obsolescencia: Nomenclatura del campo de tiempo de espera.

• call_duration (número entero o nulo): Es la duración total de la llamada en segundos.

• hold_duration (número entero o nulo): Es el tiempo total que el cliente pasó en espera, en segundos, o nulo si no hubo tiempo de espera.

• rating (número entero o nulo): Es la calificación de satisfacción del cliente (CSAT) que envió el consumidor o nulo si el consumidor no envió una calificación.

• has_feedback (booleano): Es una marca que indica si el consumidor proporcionó comentarios después de la llamada.

• voip_provider (cadena): Es el proveedor de VoIP de la llamada. (Nota: Este campo está obsoleto y siempre devuelve "deprecated").

• out_ticket_id (cadena o nulo): Es el ID del ticket que creó UJET en el sistema de CRM externo.

• out_ticket_url (cadena, URI o nulo): Es la URL del ticket del CRM.

• is_out_ticket_account (booleano o nulo): Indica si el ticket de CRM representa a un cliente (verdadero) o una interacción de llamada (falso).

• verified (booleano): Indica si la acción inteligente de verificación verificó la interacción.

• recording_url (cadena, URI o nulo): Es la URL de la grabación de llamadas o nulo si no hay ninguna grabación disponible.

• recording_permission (cadena o nulo): Es el estado del permiso de grabación del consumidor. Los valores posibles son "not_asked", "granted" y "denied".

• voicemail_reason (cadena): Es el motivo de un mensaje de voz, si corresponde. Las opciones incluyen "not_voicemail", "temporary_redirection" y "after_hour_deflection".

• disconnected_by (cadena o nulo): Indica qué parte finalizó la llamada. Valores posibles: disconnected_by_unknown, disconnected_by_agent, disconnected_by_end_user, disconnected_by_virtual_agent, disconnected_by_system.

• fail_reason (cadena o nulo): Es el motivo por el que falló una llamada o "nada" para las llamadas que no fallaron. Los valores posibles incluyen 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 y voip_conn_signal.

• fail_details (cadena o nulo): Es un detalle adicional legible que acompaña a fail_reason, cuando está disponible.

• adapter_fail_code (número entero o nulo): Código numérico correspondiente a fail_reason a nivel de la llamada. Es nulo cuando la llamada no falló. La misma enumeración se usa en el adapter_fail_code por participante en el §17.

• adapter_fail_message (cadena o nulo): Es el mensaje legible correspondiente a adapter_fail_code. Es nulo cuando la llamada no falló.

• support_number (cadena o nulo): Es el número de teléfono que marcó el consumidor para comunicarse con el centro de contacto, en formato E.164. Se completa para las llamadas originadas en el IVR. Puede ser nulo para otros canales.

• queue_priority_level (número entero; presente solo cuando la prioridad de la cola está habilitada en tu cuenta): Es la prioridad de la cola asignada a la llamada.

Información del agente y del agente virtual

En estas secciones, se explica quién o qué controló la llamada:

• agent_info (objeto): Este campo puede contener información sobre un agente humano o un agente virtual. Usa la palabra clave oneOf para especificar que puede ser uno de dos tipos.

  • agent (objeto): Es información sobre el agente humano:

    • id (número entero): Es el ID único del agente.

    • agent_number (cadena o nulo): Es un identificador asignado al agente.

    • email (cadena, correo electrónico): Es la dirección de correo electrónico del agente.

    • name (cadena): Es el nombre completo del agente.

    • last_name (cadena): Es el apellido del agente.

    • first_name (cadena): Es el nombre del agente.

    • avatar_url (cadena, URI): Es la URL de la imagen del avatar del agente.

  • virtual_agent (objeto): Es información sobre el agente virtual:

    • id (número entero): Es el ID único del agente virtual.

    • name (cadena): Es el nombre del agente virtual.

    • avatar_url (cadena, URI o nulo): Es la URL de la imagen del avatar del agente virtual.

    • va_alias (cadena o nulo): Es el alias de la pantalla del agente virtual, si estableces uno. Siempre está presente en la carga útil; es nulo cuando no se establece ningún alias.

Navegación del menú

• selected_menu (objeto o nulo): Es información sobre el menú que seleccionó el consumidor durante la llamada.

  • id (número entero): ID único del menú.

  • name (cadena): Nombre del menú.

  • parent_id (número entero o nulo): Es el ID del menú principal, si hay alguno.

  • position (número entero): Posición del menú en relación con otros menús del mismo nivel.

  • deleted (booleano): Indica si se borró el menú.

  • menu_type (cadena): Es el tipo de menú (por ejemplo, ivr_menu o sms_menu).

  • hidden (booleano): Indica si el menú está visible y disponible para su uso.

• menu_path (objeto o nulo): Describe la ruta jerárquica de los menús por los que navegó el consumidor.

  • items_count (número entero): Es la cantidad de menús en la ruta de acceso.

  • name (cadena): Cadena de nombres de menú separados por barras (por ejemplo, "Support/Billing").

  • materialized_path (cadena): Es una cadena de IDs de menú separados por barras.

• automation_redirection (objeto; presente solo cuando el primer registro de desvío de la llamada está asociado con un grupo de redireccionamiento): Detalles sobre el redireccionamiento de la cola basado en porcentajes que afectó el enrutamiento de esta llamada.

  • percent_redirection (booleano): Indica si habilitaste el redireccionamiento basado en porcentajes en el menú de origen.

  • redirection_group (array): Es un array de un solo elemento que contiene los detalles del grupo de redireccionamiento:

    • group_label (cadena): Es la etiqueta legible del grupo de redireccionamiento (por ejemplo, "Grupo de redireccionamiento 1").

    • destination (objeto o nulo): Es el destino de redireccionamiento que configuraste en el grupo.

    • after_hours (booleano o nulo): Indica si habilitaste las opciones de desvío fuera de horario en el grupo.

    • ah_destination (objeto o nulo): Es el destino de redireccionamiento fuera del horario de atención que configuraste en el grupo.

Detalles del usuario final

• end_user (objeto o nulo): Es la información sobre el consumidor:

  • id (número entero o nulo): Es el ID interno del consumidor.

  • identifier (cadena o nulo): Es un identificador externo para el consumidor.

  • out_contact_id (cadena o nulo): Es el ID del consumidor en el CRM.

Datos personalizados y proporcionados por el SDK

• customer_flag (objeto; presente solo cuando el sitio web pasó datos de autenticación personalizados): Son atributos de datos personalizados relacionados con la autenticación que la app o el sitio web del consumidor pasaron al inicio de la sesión. La carga útil incluye solo el subconjunto que designas como parámetros de autenticación.

• api_dap_request (objeto; presente solo cuando habilitas los parámetros de datos y los configuras para que se incluyan en los metadatos de la sesión): Es una instantánea de los valores de los parámetros de datos de la llamada, tal como los configuras en la configuración de la API externa de tu cuenta. Los tipos de claves y valores dependen de la configuración de los parámetros de datos.

• form_responses (array; presente solo cuando el consumidor envió al menos una respuesta de formulario): Son las respuestas que recopilaron los formularios del SDK durante la llamada. Cada entrada contiene lo siguiente:

  • id (cadena o número entero): Es el identificador de la respuesta del formulario.

  • title (cadena): Es el título del formulario que se muestra al consumidor.

  • smart_action_id (número entero o nulo): Es el identificador de la acción inteligente que activó el formulario, si corresponde.

  • questions (array): Pares de preguntas y respuestas recopilados.

Archivos adjuntos

• photos (array): Fotos que subió el consumidor durante la llamada.

  • id (número entero): Es el identificador único de la foto.

  • photo_type (cadena): Tipo o fuente de la foto (por ejemplo, "foto").

  • url (cadena, URI): URL de la foto almacenada.

  • smart_action_type (cadena o nulo): Es la acción inteligente que produjo la foto, si corresponde.

  • transfer_id (número entero o nulo): Es el ID del evento de transferencia de la foto, si el consumidor la subió después de una transferencia.

• videos (matriz): Videos que subió el consumidor durante la llamada.

  • id (número entero): Es el identificador único del video.

  • url (cadena, URI): URL del video almacenado.

  • smart_action_type (cadena o nulo): Es la acción inteligente que produjo el video, si corresponde.

  • transfer_id (número entero o nulo): Es el ID del evento de transferencia del video, si el consumidor lo subió después de una transferencia.

Desvío de llamadas

• deflection (cadena): Indica si se desvió la llamada y cómo se desvió (por ejemplo, "no_deflection", "over_cap_phone" o "after_hours_voicemail").

• deflection_details (matriz): Proporciona un registro detallado de las desviaciones durante la llamada. El campo de desviación dentro de cada entrada usa la enumeración definida en Definiciones: desviación. Cada entrada incluye lo siguiente:

  • id (número entero): Es el identificador único del registro de desvío.

  • call_id (número entero): Es el identificador único de la llamada.

  • transfer_id (número entero o nulo): Es el identificador único de la transferencia asociada con la desviación, si corresponde.

  • deflection (cadena; consulta Definiciones: desvío para ver los valores permitidos): Es el tipo de desvío.

  • created_at (cadena, fecha y hora): Es la marca de tiempo en la que se produjo la desviación.

  • from_menu_path (objeto o nulo): Es la ruta del menú desde la que se inició la desviación.

  • to_menu_path (objeto o nulo): Es la ruta de acceso del menú al que UJET desvió la llamada.

  • to_sip_uri (cadena; presente solo cuando UJET desvió la llamada a un destino SIP): Es el URI de SIP al que UJET desvió la llamada, si corresponde.

  • to_sip_headers (objeto; presente solo cuando UJET desvió la llamada a un destino SIP): Encabezados SIP con los que UJET desvió la llamada, si corresponde.

Transferencias

• transfers (array): Una entrada por cada evento de transferencia durante la llamada. Registra las transferencias en frío y en caliente entre agentes, agentes virtuales y menús.

  • id (número entero): Es el identificador único de la transferencia.

  • status (cadena): Es el estado actual de la transferencia (por ejemplo, en transferencia, conectado o fallido).

  • fail_reason (cadena): Es el motivo por el que falló la transferencia o "nothing" si no falló.

  • created_at (cadena, fecha y hora): Fecha y hora en que se inició la transferencia.

  • assigned_at (cadena, fecha y hora o nulo): Fecha y hora en que UJET asignó la transferencia a la parte receptora.

  • connected_at (cadena, fecha y hora o nulo): Es la fecha y hora en que se conectó la transferencia.

  • updated_at (cadena, fecha y hora): Fecha y hora en que UJET actualizó el registro de transferencia por última vez.

  • call_duration (número entero): Duración de la llamada del segmento transferido, en segundos.

  • wait_duration (número entero): Tiempo que esperó el consumidor durante la transferencia, en segundos.

  • deflection (cadena): Es el tipo de desvío asociado a la transferencia, si corresponde.

  • answer_type_path (cadena o nulo): Es la ruta que describe cómo se resolvió la llamada transferida.

  • from_menu_path / to_menu_path (objeto o nulo): Es la ruta de acceso al menú antes y después de la transferencia. Tiene la misma forma que menu_path en Definiciones.

  • from_agent / to_agent (objeto o nulo): Es el agente humano en cada lado de la transferencia. Tiene la misma forma que el objeto agent en Definitions.

  • from_virtual_agent / to_virtual_agent (objeto o nulo): Es el agente virtual en cada lado de la transferencia. Tiene la misma forma que el objeto virtual_agent en Definitions.

  • from_queue_priority_level / to_queue_priority_level (número entero o nulo): Prioridad de la cola antes y después de la transferencia. Solo está presente cuando habilitas la prioridad de la fila en tu cuenta.

Duraciones de manejo de llamadas

• handle_durations (array): Es un array de objetos, cada uno de los cuales representa un segmento de la llamada que controló un agente. Esto permite analizar el tiempo de procesamiento del agente.

  • id (número entero): Es el identificador único de la duración del identificador.

  • agent_id (número entero): ID del agente.

  • acw_duration (número entero): Duración del trabajo posterior a la llamada.

  • bcw_duration (número entero): Duración del trabajo previo a la llamada.

  • call_duration (número entero): Duración de la llamada durante este segmento.

  • menu_path_id (número entero o nulo): Es el ID de la ruta del menú.

  • menu_path (cadena): Nombre de la ruta de acceso del menú.

  • lang (cadena): Idioma utilizado.

  • barged (booleano): Indica si el supervisor interrumpió la llamada.

  • transfer (booleano): Indica si se produjo una transferencia.

  • transfer_id (número entero o nulo): Es el ID de la transferencia.

  • transfer_cold (booleano o nulo): Indica si la transferencia fue directa.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio.

  • ended_at (cadena, fecha y hora o nulo): Es la marca de tiempo de finalización.

  • scheduled_at (cadena, fecha y hora o nulo): Es la marca de tiempo programada.

  • hold_duration (número entero o nulo): Es la duración de la retención durante este segmento.

  • assigned_connection_duration (número entero): Es la duración durante la que el consumidor esperó mientras el agente se conectaba durante esta fase.

  • session_breakthrough (objeto; presente solo cuando la llamada interrumpió el estado no disponible de un agente): Detalles sobre la asignación de la llamada que interrumpió el estado no disponible de un agente, si corresponde.

Duraciones de la cola

• queue_durations (array): Es un array de objetos, cada uno de los cuales representa un segmento de la llamada en el que el cliente estuvo en una fila. Esto permite analizar los tiempos de espera y los niveles de servicio.

  • id (número entero): Es el identificador único de la duración de la cola.

  • agent_id (número entero): ID del agente.

  • ended_at (cadena, fecha y hora): Es la marca de tiempo de finalización.

  • lang (cadena): Idioma utilizado.

  • menu_path_id (número entero): ID de la ruta de acceso del menú.

  • menu_path (cadena): Nombre de la ruta de acceso del menú.

  • queue_duration (número entero): Duración del segmento de la cola.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio.

  • transfer_cold (booleano): Indica si la llamada se transfirió en frío.

  • transfer (booleano): Indica si se produjo una transferencia.

  • transfer_id (número entero o nulo): Es el ID de la transferencia.

  • service_level_abandon_time_threshold (número entero): Es el umbral de tiempo para el abandono del nivel de servicio.

  • service_level_event (cadena): Estado del evento de nivel de servicio ("excluded", "in_sla", "not_in_sla").

  • service_level_target_percent (número entero): Es el porcentaje objetivo de cumplimiento del nivel de servicio.

  • service_level_target_time (número entero): Es el tiempo objetivo para el cumplimiento del nivel de servicio.

Derivaciones de agente virtual a humano

• escalations (array): Cada entrada representa una derivación de un agente virtual a un agente humano.

  • id (número entero): Es el identificador único de la derivación.

  • status (cadena): Es el estado actual (por ejemplo, en aumento, aumentado o fallido).

  • reason (cadena): Es el motivo por el que se derivó la sesión.

  • created_at (cadena, fecha y hora): Fecha y hora en que comenzó la derivación.

  • escalated_at (cadena, fecha y hora o nulo): Fecha y hora en que finalizó la derivación.

  • from_virtual_agent (objeto o nulo): Es el agente virtual que derivó la llamada. Tiene la misma forma que el objeto virtual_agent en Definitions.

  • to_agent (objeto o nulo): Es el agente humano al que se derivó la llamada. Tiene la misma forma que el objeto agent en Definitions.

  • from_menu_path / to_menu_path (objeto o nulo): Es la ruta de acceso al menú antes y después de la derivación.

Derivaciones de agentes virtuales

• virtual_agent_deflected_escalations (array): Detalles de las derivaciones rechazadas de los agentes virtuales.

  • id (número entero): Es el identificador único.

  • deflection (cadena): Tipo de desvío.

  • escalation_id (número entero): Es el identificador del evento de derivación.

  • escalation_reason (cadena): Es el motivo de la derivación.

  • escalated_at (cadena, fecha y hora): Es la marca de tiempo de la derivación.

  • menu_path_id (número entero): ID de la ruta de acceso del menú.

  • menu_path (cadena): Ruta de acceso al menú.

  • lang (cadena): Idioma.

  • virtual_agent (objeto): Detalles del agente virtual. Consulta Definiciones.

Duraciones de atención de agentes virtuales

• virtual_agent_handle_durations (matriz): Son los segmentos de tiempo en los que un agente virtual atendió la llamada.

  • id (número entero): Es el identificador único.

  • virtual_agent (objeto): Detalles del agente virtual. Consulta Definiciones.

  • call_duration (número entero): Duración del segmento.

  • escalation_reason (cadena): Es el motivo de la derivación.

  • finish_reason (cadena): Es el motivo por el que finalizó la interacción.

  • sentiment (número entero): Opinión de los consumidores.

  • response_count (número entero): Recuento de respuestas del agente virtual.

  • fallback_response_count (número entero): Es el recuento de respuestas de resguardo.

  • initiated_by (cadena): Indica cómo se inició la sesión del agente virtual.

  • menu_path_id (número entero): ID de la ruta de acceso del menú.

  • menu_path (cadena): Ruta de acceso al menú.

  • lang (cadena): Idioma.

  • transfer (booleano): Indica si se transfirió la llamada.

  • transfer_id (número entero o nulo): Es el identificador del evento de transferencia.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio.

  • ended_at (cadena, fecha y hora o nulo): Es la marca de tiempo de finalización.

Duraciones de la manipulación del consumidor

• consumer_handle_durations (matriz): Son los períodos durante los que el consumidor estuvo en la llamada.

  • id (número entero): Es el identificador único.

  • call_duration (número entero): Es la duración del segmento de consumidores.

  • hold_duration (número entero o nulo): Es la duración de la conservación del consumidor.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio.

  • ended_at (cadena, fecha y hora): Es la marca de tiempo de finalización.

Duraciones de los eventos de consumo

• consumer_event_durations (matriz): Detalles de los eventos de llamadas de los consumidores (como CSAT o pago).

  • id (número entero): Es el identificador único.

  • duration (número entero): Duración del evento.

  • type (cadena): Tipo de evento.

  • event (cadena): Es el resultado del evento.

  • menu_path_id (número entero): ID de la ruta de acceso del menú.

  • menu_path (cadena): Ruta de acceso al menú.

  • lang (cadena): Idioma.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio.

  • ended_at (cadena, fecha y hora): Es la marca de tiempo de finalización.

Duraciones de los videos de los consumidores en el menú

• consumer_in_menu_durations (array): Duraciones de las interacciones del consumidor en los menús.

  • id (número entero): Es el identificador único.

  • duration (número entero): Duración dentro del menú.

  • event (cadena): Es el resultado de la interacción con el menú.

  • menu_path_id (número entero): ID de la ruta de acceso del menú.

  • menu_path (cadena): Ruta de acceso al menú.

  • lang (cadena): Idioma.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio.

  • ended_at (cadena, fecha y hora): Es la marca de tiempo de finalización.

Participantes

• participants (array): Es información sobre cada participante de la llamada (por ejemplo, el consumidor, el agente o el agente virtual).

  • id (número entero): Es el identificador único del participante.

  • type (cadena): Tipo de participante ("end_user", "agent", "virtual_agent", etc.).

  • entry_type (cadena): Indica cómo ingresó el participante a la llamada.

  • user_id (número entero o nulo): ID de usuario si el participante es un agente.

  • end_user_id (número entero o nulo): Es el identificador del consumidor si el participante es el consumidor.

  • virtual_agent_id (número entero o nulo): ID del agente virtual si el participante es un agente virtual.

  • virtual_agent_params (objeto; presente solo cuando configuras metadatos personalizados del agente virtual para su inclusión): Son los metadatos personalizados que usa el agente virtual.

  • status (cadena): Es el estado del participante (“waiting”, “connected”, “finished”, etc.).

  • fail_reason (cadena): Es el motivo de la falla, si corresponde.

  • connected_at (cadena, fecha y hora o nulo): Es la marca de tiempo en la que se conectó el participante.

  • phone_number (cadena; solo está presente en los participantes consumidores): Número de teléfono del participante.

  • call_id (número entero): Es el identificador de la llamada.

  • call_duration (número entero o nulo): Duración de la llamada para el participante.

  • hold_duration (número entero o nulo): Es la duración de la espera para el participante.

  • ended_at (cadena, fecha y hora o nulo): Es la marca de tiempo del momento en que finalizó la participación del participante.

  • adapter_fail_code (número entero o nulo): Código numérico correspondiente al motivo del error.

  • adapter_fail_message (cadena o nulo): Es la descripción legible de fail_reason, si está presente.

  • agent_assist (objeto; solo presente en los participantes agentes cuando configuras Agent Assist): Es la configuración activa de Agent Assist para este participante.

  • virtual_agent (objeto; presente solo en participantes de agentes virtuales): Detalles del agente virtual que actúa como este participante, distinto del agent_info de nivel superior y de virtual_agent_params.

  • caller_id (cadena; solo está presente cuando habilitas el identificador de llamadas del encabezado SIP en tu cuenta y solo en los participantes consumidores): Es el identificador de llamadas que UJET extrae de los encabezados SIP entrantes para este participante consumidor.

  • sip_headers (objeto o nulo): Son los encabezados SIP asociados a este participante. Siempre está presente en la carga útil; es nulo cuando UJET no captura encabezados.

  • location (cadena o nulo; presente solo en los participantes agentes): Es la ubicación del agente.

  • location_id (número entero o nulo; presente solo en los participantes agentes): Es el ID de ubicación.

  • email (cadena, correo electrónico; solo presente en los participantes agentes): Dirección de correo electrónico del agente.

  • first_name (cadena o nulo; presente solo en los participantes del agente): Es el nombre del agente.

  • last_name (cadena o nulo; presente solo en los participantes agentes): Es el apellido del agente.

  • middle_name (cadena o nulo; presente solo en participantes agentes): Es el segundo nombre del agente.

  • teams (matriz; solo presente en los participantes agentes): Es un array de objetos { id, name } para los equipos del agente.

Grabaciones

• recordings (matriz): Es información sobre la grabación del audio de la llamada.

  • id (número entero): Es el identificador único de la grabación.

  • call_id (número entero): Es el identificador de la llamada.

  • conference_sid (cadena o nulo): Es el identificador de llamada del proveedor de VoIP.

  • duration (número entero o nulo): Duración de la grabación.

  • recording_type (cadena): Tipo de grabación.

  • redaction_times (array): Segmentos de tiempo censurados.

    • start (cadena, fecha y hora): Es la fecha y hora en que comenzó el intervalo de ocultamiento.

    • end (cadena, fecha y hora): Es la fecha y hora en la que finalizó el intervalo de ocultamiento.

    • duration (número entero): Duración de la redacción, en segundos.

    • start_agent_id (número entero o nulo): Es el agente que inició la redacción.

    • end_agent_id (número entero o nulo): Es el agente que finalizó la ocultación.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio de la grabación.

• post_processed_recordings (matriz; presente solo cuando habilitas la grabación con procesamiento posterior en tu cuenta): Grabaciones de audio que produce el procesamiento posterior (como la conversión de formato o la redacción).

  • id (número entero): Es el identificador único de la grabación posterior al procesamiento.

  • call_id (número entero): Es el identificador de la llamada.

  • duration (número entero): Duración de la grabación en segundos.

  • started_at (cadena, fecha y hora): Marca de tiempo de inicio de la grabación.

  • recording_file_name (cadena): Es el nombre de archivo del recurso de audio procesado posteriormente.

  • recording_url (cadena, URI): URL del archivo de audio posprocesado.

  • agent_id (número entero o cadena): Es el identificador del agente asociado con el segmento.

  • virtual_agent_id (número entero o cadena): Es el identificador del agente virtual asociado con el segmento, si corresponde.

  • conversation_id (cadena): Es el identificador que correlaciona esta grabación con su registro de conversación.

• segments (array; presente solo cuando habilitas las grabaciones de estadísticas posteriores al procesamiento en tu cuenta): Son los segmentos de audio (y de grabación de pantalla opcionales) por participante que el sistema produce para las canalizaciones de estadísticas posteriores.

  • id (número entero): Es el identificador único del segmento.

  • call_id (número entero): Es el identificador de la llamada.

  • duration (número entero): Duración del segmento en segundos.

  • started_at (cadena, fecha y hora): Es la marca de tiempo de inicio del segmento.

  • audio_file_name (cadena): Es el nombre de archivo del activo de audio del segmento.

  • audio_url (cadena, URI): URL del archivo de audio del segmento.

  • agent_id (número entero o cadena): Es el identificador del agente asociado con el segmento.

  • virtual_agent_id (número entero o cadena): Es el identificador del agente virtual asociado con el segmento, si corresponde.

  • participant_id (número entero o cadena): Es el identificador del participante al que pertenece el segmento.

  • conversation_id (cadena): Es el identificador que correlaciona este segmento con su registro de conversación.

  • screen_recording_url (cadena, URI o nulo): URL del recurso de grabación de pantalla coincidente. Solo se presenta cuando habilitas la grabación de pantalla en tu cuenta.

  • screen_recording_file_name (cadena o nulo): Es el nombre de archivo de la grabación de pantalla. Se presenta en las mismas condiciones que screen_recording_url.

Eventos de ofertas

• offer_type (cadena o nulo): Indica cómo UJET ofreció la llamada al agente.

• offer_events (array): Eventos cuando UJET ofreció la llamada a los agentes.

  • casting_time (cadena, fecha y hora): Fecha y hora en que UJET ofreció la llamada.

  • group (cadena): Grupo al que UJET ofreció la llamada.

Otros detalles

• answer_type (cadena o nulo): Cómo se resolvió la llamada ("manual" o "auto").

• outbound_number (cadena o nulo): Es el número de teléfono saliente que se usó.

• wait_time_sms (array; presente solo cuando se produjeron interacciones por SMS de tiempo de espera en esta llamada): Son las interacciones por SMS que UJET envió al consumidor sobre el tiempo de espera previsto. Cada entrada contiene lo siguiente:

  • transfer_id (número entero o nulo): Es el identificador del evento de transferencia, si está asociado a una transferencia.

  • status (cadena): Es el estado del SMS. Valores posibles: not_triggered, triggered, triggered_allowed, triggered_denied, triggered_no_selection, triggered_sent, triggered_failed.

  • received (booleano): Indica si el consumidor recibió el SMS.

• in_call_sms (matriz; solo está presente cuando se produjeron interacciones de SMS durante la llamada): Interacciones de SMS durante la llamada. Cada entrada contiene lo siguiente:

  • transfer_id (número entero o nulo): Es el identificador del evento de transferencia, si está asociado a una transferencia.

  • preset_sent (booleano): Indica si UJET envió un mensaje predeterminado.

  • custom_sent (booleano): Indica si el agente envió un mensaje personalizado (de texto libre).

  • received (booleano): Indica si UJET recibió un SMS del consumidor.

• dispositions (matriz; presente solo cuando habilitas códigos o notas de cierre en tu cuenta): Son los códigos y las notas de cierre que registraron los agentes. Cada entrada incluye campos renderizados de forma dinámica según la configuración del resumen:

  • user_id (número entero): Es el identificador del agente.

  • transfer_id (número entero o nulo): Es el identificador del evento de transferencia, si se registró después de una transferencia.

  • participant_id (número entero): Es el identificador del participante.

  • note (cadena): Nota de texto libre del agente.

  • original_note (cadena): Es la versión original (anterior a la edición) de la nota.

  • code (cadena): Es el nombre del código de disposición.

  • ujet_code_id (número entero o cadena vacía): Es el ID de UJET del código de disposición, una clave estable para el código (el nombre visible del código puede cambiar). Cadena vacía cuando no está disponible.

  • list (cadena): Nombre de la lista a la que pertenece el código.

  • list_path (cadena): Es la ruta de acceso separada por barras diagonales de la lista de códigos.

  • ujet_list_id (número entero o cadena vacía): Es el ID de UJET de la lista a la que pertenece el código de disposición, una clave estable para la lista. Cadena vacía cuando no está disponible.

  • custom_list_id (cadena o número entero): Es el identificador de la lista definida por el cliente, si se asignó.

  • custom_code_id (cadena o número entero): Es el identificador de código definido por el cliente, si se asignó.

• email (cadena, correo electrónico o nulo): Es la dirección de correo electrónico del consumidor.

• feedback (cadena o nulo): Comentarios del consumidor.

• smart_action_text (cadena o nulo): Es el texto de cualquier acción inteligente que se haya realizado.

• custom_data_secured (objeto o nulo): Son datos personalizados firmados de forma segura.

• custom_data_not_secured (objeto o nulo): Datos personalizados y no firmados de forma segura.

• in_queue_wait_time_va (array; presente solo cuando habilitas el seguimiento del tiempo de espera en la fila para los agentes virtuales en tu cuenta y solo cuando se produjo al menos una derivación a un AV conservado): Son los intervalos de tiempo en los que el cliente esperó en la fila mientras UJET conservaba un agente virtual para él después de la derivación. Cada entrada contiene lo siguiente:

  • start (cadena, fecha y hora): Indica cuándo comenzó la espera en la fila.

  • end (cadena, fecha y hora o nulo): Fecha y hora en que finalizó la espera en la cola. Es nulo si no se completó.

  • duration (número entero o nulo): Duración de espera en segundos; nulo cuando end es nulo.

• auto_session_summaries (matriz; presente solo cuando habilitas la generación de resúmenes de conversaciones en tu cuenta y UJET generó correctamente un resumen): Son los resúmenes de sesiones generados por IA que UJET guarda en el registro del CRM. Cada entrada contiene lo siguiente:

  • user_id (número entero): Es el identificador del participante del agente con el que se asocia el resumen.

  • participant_id (número entero): Es el identificador del participante.

  • session_summary (cadena): Es el texto del resumen.

  • session_summary_sections (matriz o objeto): Es el resumen en secciones estructuradas, si está disponible.

• sip_headers (objeto; presente solo cuando habilitas la captura de encabezados SIP en tu cuenta y la configuras para que se incluya en los metadatos de la sesión): Son los encabezados SIP entrantes que UJET capturó para la llamada. Las claves y los valores reflejan los encabezados SIP recibidos del proveedor de telefonía upstream.

Definiciones

En esta sección, se define cada subesquema una vez. Los grupos de propiedades que hacen referencia a los subesquemas se vinculan a estas definiciones en lugar de redefinir sus formas de forma intercalada.

menu_path (objeto)

Describe una ruta de menú jerárquica que atravesó la llamada. Consulta Navegación por el menú para ver la lista completa de sus campos.

Referenciado desde: El campo menu_path de nivel superior; cada transfers[].from_menu_path y transfers[].to_menu_path; cada escalations[].from_menu_path y escalations[].to_menu_path; cada deflection_details[].from_menu_path y deflection_details[].to_menu_path.

agent (objeto)

Describe a un agente humano. Este objeto es una de las dos variantes del discriminador agent_info de nivel superior (consulta Raíz del esquema). Consulta Información del agente y del agente virtual para obtener la lista completa de sus campos.

Referenced from: El campo agent_info cuando un agente humano atendió la llamada por última vez; cada transfers[].from_agent y transfers[].to_agent; cada escalations[].to_agent.

virtual_agent (objeto)

Describe un agente virtual. Este objeto es una de las dos variantes del discriminador agent_info de nivel superior (consulta Raíz del esquema). Consulta Información del agente y del agente virtual para ver la lista completa de sus campos.

Referenced from: El campo agent_info cuando un agente virtual atendió la llamada por última vez; cada transfers[].from_virtual_agent y transfers[].to_virtual_agent; cada escalations[].from_virtual_agent; cada virtual_agent_handle_durations[].virtual_agent; cada virtual_agent_deflected_escalations[].virtual_agent.

desviación (cadena, enum)

Es el estado de desvío de una llamada o un segmento de llamada. Los valores siguen un patrón de nombres <trigger>_<destination>, en el que el prefijo identifica la condición que activó la desviación (por ejemplo, exceso de capacidad, fuera de horario o redireccionamiento temporal) y el sufijo identifica el destino o el tratamiento (por ejemplo, correo de voz, fila, teléfono o mensaje).

Sufijos de destino comunes:

• _phone: Enruta la llamada a un número de teléfono externo.

• _voicemail: Dirige la llamada al buzón de voz.

• _message: Reproduce un mensaje informativo.

• _message_only: Reproduce un mensaje y finaliza la llamada sin redireccionarla.

• _callback: Ofrece una devolución de llamada programada.

• _wait: Mantiene a la persona que llama en espera.

• _queue: Coloca la llamada en otra cola.

• _sip: Enruta la llamada a un destino SIP.

• _extension: Enruta la llamada a una extensión.

• _phone_with_extension: Enruta la llamada a un destino telefónico con una extensión.

Valores permitidos, agrupados por familia de activadores:

• Sin desvío: no_deflection, deflecting.

• Exceso de capacidad: Cuando la fila superó su umbral de capacidad: 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.

• Fuera de horario: Cuando la llamada llegó fuera del horario de atención configurado del menú: 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.

• Redireccionamiento temporal: Cuando configuras un redireccionamiento temporal en el menú: temp_redirection_phone, temp_redirection_message, temp_redirection_voicemail, temp_redirection_queue, temp_redirection_sip, temp_redirection_extension, temp_redirection_phone_with_extension.

• IVR previo a la sesión: ivr_presession_deflection.

• Iniciada por el agente virtual: Cuando un agente virtual redireccionó o transfirió la llamada: va_redirection_phone, va_redirection_sip, va_third_party_phone, va_third_party_sip.

• Llamadas internas fuera del horario de atención: 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.

• Sobrecarga de llamadas internas: 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.

• Redireccionamiento automático de llamadas 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.

• Transferencia de llamadas fuera del horario de atención: 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.

• Capacidad excesiva de transferencia de llamadas: 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.

• Redireccionamiento automático de transferencia de llamadas: 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.

• Apagado de emergencia: Cuando un administrador activó un apagado de emergencia: emergency_shutdown, emergency_shutdown_message, emergency_shutdown_after_hours, emergency_shutdown_over_capacity.

• Enrutamiento dinámico de llamadas (DCR): dcr_transferred, dcr_missed, dcr_redirected, dcr_finished.

Referenced from: El campo deflection de nivel superior, cada deflection_details[].deflection y cada transfers[].deflection.

Control de versiones y bajas

El esquema de metadatos de la sesión de llamada admite la evolución retrocompatible. UJET puede agregar campos y matrices nuevos en cualquier momento. Las integraciones deben ignorar las claves no reconocidas para garantizar la funcionalidad continua. Los campos de esta sección están obsoletos, son heredados o se reemplazaron de forma parcial. Permanecen en la carga útil para garantizar la retrocompatibilidad, pero las nuevas integraciones deben seguir la orientación para cada campo.

Campos obsoletos

• voip_provider (cadena): Obsoleto. Siempre devuelve la cadena literal "deprecated". UJET ya no muestra la información del proveedor en las integraciones a través de este documento. No hay ningún campo de reemplazo. Si tu integración necesita identificar al proveedor de telefonía upstream, comunícate con tu equipo de cuentas.

Duplicados heredados

• session_type (cadena): Es el alias heredado de call_type. Siempre devuelve el mismo valor que call_type y usa el mismo vocabulario de enumeración heredado. UJET conserva este campo para garantizar la retrocompatibilidad con las integraciones que se basan en session_type. Las nuevas integraciones deben analizar call_type directamente o, para distinciones entrantes más detalladas, session_type_v2 (consulta Evolución del vocabulario más abajo).

Evolución del vocabulario

call_type y session_type_v2 describen el mismo tipo de llamada subyacente con dos vocabularios diferentes. UJET emite ambos campos en cada registro; no son duplicados entre sí:

• call_type usa el vocabulario de enumeración heredado. Los valores como Voice Inbound (App) y Voice Inbound (IVR using App) abarcan todos los orígenes de SDKs para dispositivos móviles y en la aplicación entrantes bajo una sola etiqueta. call_type no está obsoleto. UJET seguirá emitiendo este campo, pero su vocabulario no obtendrá nuevos valores detallados.

• session_type_v2 usa el vocabulario de enumeración actual. Introduce distinciones más detalladas para las llamadas entrantes (por ejemplo, Voice Inbound (Mobile) y Voice Inbound (IVR using Mobile)) para los tipos de llamadas que tienen valores específicos de la versión 2. Para los tipos de llamadas que no tienen un valor específico de la versión 2, session_type_v2 devuelve la misma cadena que call_type.

Las nuevas integraciones deben analizar session_type_v2. Los valores de cada campo se indican en Información principal.

Nomenclatura de los campos de tiempo de espera

El documento de metadatos de la sesión de llamada informa el tiempo de espera en la cola en dos alcances, bajo dos nombres de campo:

• Total de la llamada: El campo wait_duration de nivel superior contiene el tiempo total que el consumidor pasó en la fila durante toda la llamada.

• Por segmento: Cada entrada del array queue_durations de nivel superior (Duraciones de la cola) incluye su propio campo queue_duration, que contiene el tiempo de espera de ese segmento de la cola individual.

Ambos nombres hacen referencia al mismo tipo de medición (el tiempo que se pasa en la fila) en diferentes alcances. El valor wait_duration de la llamada total refleja el tiempo total en la fila de espera del consumidor, mientras que los valores queue_duration por segmento describen cada segmento de la fila de espera. Este documento no emite un campo queue_duration independiente de nivel superior; los valores por segmento solo están disponibles dentro de queue_durations.