Listar conversaciones

GET

/v1/convai/conversations

GET

/v1/convai/conversations

curl -G https://api.elevenlabs.io/v1/convai/conversations \
     -d agent_id=agent_id \
     -d branch_id=branch_id \
     -d call_duration_max_secs=1 \
     -d call_duration_min_secs=1 \
     -d call_start_after_unix=1 \
     -d call_start_before_unix=1 \
     -d call_successful=success \
     -d conversation_initiation_source=unknown \
     -d conversation_product_type=agents \
     -d cursor=cursor \
     -d custom_guardrail_names=custom_guardrail_names \
     -d data_collection_ids=data_collection_ids \
     -d data_collection_params=data_collection_params \
     -d dynamic_variable_params=dynamic_variable_params \
     -d evaluation_criteria_ids=evaluation_criteria_ids \
     -d evaluation_params=evaluation_params \
     -d exclude_statuses=initiated \
     -d guardrail_types=custom \
     -d has_feedback_comment=true \
     -d include_invalid_tool_calls=true \
     -d main_languages=main_languages \
     -d page_size=1 \
     -d parent_conversation_id=parent_conversation_id \
     -d rating_max=1 \
     -d rating_min=1 \
     -d search=search \
     -d sort_direction=asc \
     -d summary_mode=exclude \
     -d tag_ids=tag_ids \
     -d termination_reasons=termination_reasons \
     -d text_only=true \
     -d tool_names=tool_names \
     -d tool_names_errored=tool_names_errored \
     -d tool_names_successful=tool_names_successful \
     -d topic_ids=topic_ids \
     -d triggered_procedure_ids=triggered_procedure_ids \
     -d user_id=user_id \
     -d version_id=version_id \
     -d visited_agent_branch_ids=visited_agent_branch_ids \
     -d visited_agent_ids=visited_agent_ids \
     -d workflow_node_entered_id=workflow_node_entered_id

{
  "conversations": [
    {
      "agent_id": "agent_id",
      "conversation_id": "conversation_id",
      "start_time_unix_secs": 1,
      "call_duration_secs": 1,
      "message_count": 1,
      "status": "initiated",
      "call_successful": "success",
      "branch_id": "branch_id",
      "version_id": "version_id",
      "agent_name": "agent_name",
      "termination_reason": "termination_reason",
      "call_success_score": 1.1,
      "transcript_summary": "transcript_summary",
      "call_summary_title": "call_summary_title",
      "main_language": "main_language",
      "conversation_initiation_source": "unknown",
      "tool_names": [
        "tool_names"
      ],
      "direction": "inbound",
      "rating": 1.1,
      "sentiment_analysis": {
        "overall_label": "positive",
        "overall_sentiment_score": 1.1,
        "overall_frustration_score": 1.1,
        "min_user_sentiment_score": 1.1,
        "max_user_frustration_score": 1.1,
        "num_scored_user_turns": 1
      },
      "data_collection_results": {
        "key": "value"
      },
      "tag_ids": [
        "tag_ids"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Obtén todas las conversaciones de agentes que pertenecen al usuario. Permite restringir el resultado a un agente específico.

Parámetros de consulta

cursorstringOpcional

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

agent_idstringOpcional

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

visited_agent_idsstringOpcional

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

visited_agent_branch_idsstringOpcional

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

triggered_procedure_idsstringOpcional

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

call_successfulenumOpcional

El resultado de la evaluación de éxito

Valores permitidos:

call_start_before_unixintegerOpcional

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

call_start_after_unixintegerOpcional

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

call_duration_min_secsintegerOpcional

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

call_duration_max_secsintegerOpcional

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

rating_maxintegerOpcional1-5

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

rating_minintegerOpcional1-5

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

has_feedback_commentbooleanOpcional

Filtra conversaciones con comentarios de usuarios.

user_idstringOpcional

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

evaluation_paramsstringOpcional

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_paramsstringOpcional

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_paramsstringOpcional

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 ’:’.

data_collection_idsstringOpcional

ID de los campos de recopilación de datos que se incluirán en cada resumen de conversación. Parámetro repetible. Si se omite, no se devuelve data_collection_results.

evaluation_criteria_idsstringOpcional

ID de los criterios de evaluación que se incluirán en cada resumen de conversación. Parámetro repetible. Si se omite, no se devuelve evaluation_criteria_results.

tool_namesstringOpcional

Filtra conversaciones por nombres de herramientas utilizados durante la llamada.

tool_names_successfulstringOpcional

Filtra conversaciones por nombres de herramientas cuyas llamadas se realizaron correctamente.

tool_names_erroredstringOpcional

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_languagesstringOpcional

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

page_sizeintegerOpcional1-100Valor predeterminado: 30

Número máximo de conversaciones que se devolverán. No puede superar 100; el valor predeterminado es 30.

summary_modeenumOpcionalValor predeterminado: exclude

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

Valores permitidos:

searchstringOpcionalDeprecated

Búsqueda de texto completo o aproximada en mensajes de transcripción

conversation_initiation_sourceenumOpcionalValor predeterminado: unknown

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

text_onlybooleanOpcional

conversation_product_typeenumOpcional

Restringe los resultados a una sola interfaz de producto de conversaciones.

Valores permitidos:

branch_idstringOpcional

Filtra conversaciones por ID de rama.

version_idstringOpcional

Filtra conversaciones por ID de versión.

parent_conversation_idstringOpcional

Filtra conversaciones de subagentes por ID de conversación principal.

topic_idsstringOpcional

Filtra conversaciones por IDs de temas asignados durante el descubrimiento de temas.

exclude_statusesenumOpcional

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:

tag_idsstringOpcional

Filtra conversaciones por IDs de etiquetas de conversación asignados mediante las rutas de API conversation-tags.

workflow_node_entered_idstringOpcional

Filtra para incluir solo las conversaciones que entraron en el nodo indicado.

termination_reasonsstringOpcional

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

guardrail_typesenumOpcional

Filtra conversaciones en las que se activó una barrera de seguridad de alguno de estos tipos (metadata.triggered_guardrails.guardrail_type). Repite el parámetro para que coincida con cualquiera de varios valores.

custom_guardrail_namesstringOpcional

Filtra conversaciones en las que se activó una barrera de seguridad personalizada con alguno de estos nombres (metadata.triggered_guardrails.guardrail_name). Solo las barreras de seguridad personalizadas tienen nombre. Repite el parámetro para que coincida con cualquiera de varios valores.

sort_directionenumOpcional

La dirección para ordenar las conversaciones por hora de inicio de la llamada. De forma predeterminada, descendente (más recientes primero).

Valores permitidos:

Respuesta

Respuesta correcta.

conversationslist of objects

has_moreboolean

next_cursorstringOpcional

Errores

422

Conversations List Request Unprocessable Entity Error

Encabezados

Parámetros de consulta

Respuesta

Errores