ElevenAgentsConversationsMessages

Buscar mensajes de conversación por texto

Busca en los mensajes de las transcripciones de conversaciones mediante búsqueda de texto completo y aproximada.

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

text_querystringRequerido

El texto de la consulta de búsqueda para coincidencias de texto completo y aproximadas

agent_idstring or nullOpcional

ID del agente (agent_…) o ID externo del motor de voz (seng_), que se resuelven en el mismo recurso subyacente.

visited_agent_idslist of strings or nullOpcional

Filtra conversaciones en las que participó alguno de estos agentes. No puede superar los 50 valores.

visited_agent_branch_idslist of strings or nullOpcional

Filtra conversaciones en las que participó alguna de estas ramas del agente. No puede superar los 50 valores.

triggered_procedure_idslist of strings or nullOpcional

Filtra conversaciones en las que se activó alguno de estos procedimientos. No puede superar los 50 valores.

call_successfulenum or nullOpcional

El resultado de la evaluación de éxito

Valores permitidos:
call_start_before_unixinteger or nullOpcional

Marca de tiempo Unix (en segundos) para filtrar conversaciones hasta esta fecha de inicio.

call_start_after_unixinteger or nullOpcional

Marca de tiempo Unix (en segundos) para filtrar conversaciones posteriores a esta fecha de inicio.

call_duration_min_secsinteger or nullOpcional

Duración mínima de la llamada en segundos.

call_duration_max_secsinteger or nullOpcional

Duración máxima de la llamada en segundos.

rating_maxinteger or nullOpcional1-5

Valoración global máxima (1-5).

rating_mininteger or nullOpcional1-5

Valoración global mínima (1-5).

has_feedback_commentboolean or nullOpcional
Filtra conversaciones con comentarios de usuarios.
user_idstring or nullOpcional

Filtra conversaciones por el ID del usuario que las inició.

evaluation_paramslist of strings or nullOpcional

Filtros de evaluación. Parámetro repetible. Formato: criteria_id:result, donde result es uno de success|failure|unknown. Ejemplo: eval=value_framing:success

data_collection_paramslist of strings or nullOpcional
Filtros de recopilación de datos. Parámetro repetible. Formato: id:op:value, donde op es uno de eq|neq|gt|gte|lt|lte|in. Para in, delimita los valores con barras verticales. Un valor vacío coincide con conversaciones en las que no se recopiló el campo (id:eq:), y neq con un valor vacío coincide con aquellas en las que sí se recopiló (id:neq:). eq indica igualdad exacta. gt|gte|lt|lte requieren un valor numérico.
dynamic_variable_paramslist of strings or nullOpcional
Filtros de variables dinámicas. Parámetro repetible. Formato: name:op:value, donde op es uno de eq|neq|gt|gte|lt|lte|in. Para in, delimita los valores con barras verticales. Un valor vacío coincide con conversaciones en las que no se estableció la variable (name:eq:), y neq con un valor vacío coincide con aquellas en las que sí se estableció (name:neq:). eq es igualdad exacta. gt|gte|lt|lte requieren un valor numérico. No se pueden expresar nombres que contengan ':'.
tool_nameslist of strings or nullOpcional
Filtra conversaciones por nombres de herramientas utilizados durante la llamada.
tool_names_successfullist of strings or nullOpcional
Filtra conversaciones por nombres de herramientas cuyas llamadas se realizaron correctamente.
tool_names_erroredlist of strings or nullOpcional
Filtra conversaciones por nombres de herramientas cuyas llamadas dieron error.
include_invalid_tool_callsbooleanOpcionalValor predeterminado: false

Incluye también las llamadas a herramientas que nunca se ejecutaron.

main_languageslist of strings or nullOpcional

Filtra conversaciones por idioma principal detectado (código de idioma).

exclude_statuseslist of enums or nullOpcional

Excluye las conversaciones con los estados indicados. Resulta útil para ocultar de las vistas de lista las conversaciones en curso o en procesamiento.

Valores permitidos:
termination_reasonslist of strings or nullOpcional

Filtra conversaciones por su termination_reason almacenado (metadata.termination_reason). Repite el parámetro para que coincida con cualquiera de varios valores.

page_sizeintegerOpcional1-50Valor predeterminado: 20

Número de resultados por página. Máximo: 50.

summary_modeenumOpcionalValor predeterminado: exclude

Indica si se deben incluir resúmenes de las transcripciones en la respuesta.

Valores permitidos:
conversation_initiation_sourceenum or nullOpcionalValor predeterminado: unknown

Enumeración que representa los posibles orígenes para iniciar una conversación.

text_onlyboolean or nullOpcional
conversation_product_typeenum or nullOpcional
Restringe los resultados a una sola interfaz de producto de conversaciones.
Valores permitidos:
branch_idstring or nullOpcional
Filtra conversaciones por ID de rama.
version_idstring or nullOpcional

Filtra conversaciones por ID de versión.

topic_idslist of strings or nullOpcional
Filtra conversaciones por IDs de temas asignados durante el descubrimiento de temas.
sort_byenumOpcional

Orden de los resultados de búsqueda. ‘search_score’ ordena por puntuación de búsqueda y ‘created_at’ por hora de inicio de la conversación.

Valores permitidos:
cursorstring or nullOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.
resultslist of objects
has_moreboolean

Indica si hay más resultados disponibles

metaobjectOpcional
next_cursorstring or nullOpcional

Cursor para la siguiente página de resultados

Errores

422
Unprocessable Entity Error